org.carrot2.labs.smartsprites.resource

Interface ResourceHandler

All Known Implementing Classes:

FileSystemResourceHandler

public interface ResourceHandler

Defines an abstraction layer for resource (CSS, images) management. Resources are defined by means of abstract implementation-dependent paths represented by plain Strings. Responsibility for closing of all resources acquired from this interface rests with the caller.

Author:

Ibrahim Chaehoi, Stanislaw Osinski

Method Summary

Methods

Modifier and Type	Method and Description
InputStream	getResourceAsInputStream(String path) Returns the resource input stream for the provided path.
OutputStream	getResourceAsOutputStream(String path) Returns the resource output stream for the provided path.
Reader	getResourceAsReader(String path) Returns the reader for the provided path.
Writer	getResourceAsWriter(String path) Returns the writer for the provided path.
String	getResourcePath(String cssFilePath, String cssRelativePath) Builds a resource path relative to a CSS file resource path.

Method Detail

getResourceAsInputStream

InputStream getResourceAsInputStream(String path)
                                     throws IOException

Returns the resource input stream for the provided path.

Parameters:

path - the resource path

Returns:

the resource stream or null if the resource could not be opened.

Throws:

IOException

getResourceAsReader

Reader getResourceAsReader(String path)
                           throws IOException

Returns the reader for the provided path. Implementations are responsible for creating the reader with the right charset.

Parameters:

path - the resource path

Returns:

the reader or null if the resource could not be opened.

Throws:

IOException

getResourceAsOutputStream

OutputStream getResourceAsOutputStream(String path)
                                       throws IOException

Returns the resource output stream for the provided path. If the resource already exists, its content should be overwritten.

Parameters:

path - the resource path

Returns:

the resource stream or null if the resource could not be opened.

Throws:

IOException

getResourceAsWriter

Writer getResourceAsWriter(String path)
                           throws IOException

Returns the writer for the provided path. If the resource already exists, its content should be overwritten. Implementations are responsible for creating the writer with the right charset.

Parameters:

path - the resource path

Returns:

the writer or null if the resource could not be opened.

Throws:

IOException

getResourcePath

String getResourcePath(String cssFilePath,
                     String cssRelativePath)

Builds a resource path relative to a CSS file resource path.

Parameters:

cssFilePath - the CSS file path (base)

cssRelativePath - the relative path to be resolved against the cssFilePath. If the resource path starts with the '/' character, it is an absolute resource and should be resolved against the SmartSpritesParameters.getDocumentRootDir() path instead. All other resource paths should be assumed to be relative to the cssFilePath.

Returns:

the combined resource path