org.carrot2.labs.smartsprites.resource

Class FileSystemResourceHandler

java.lang.Object

org.carrot2.labs.smartsprites.resource.FileSystemResourceHandler

All Implemented Interfaces:

ResourceHandler

public class FileSystemResourceHandler
extends Object
implements ResourceHandler

This class defines the resource handler which manage resources from the file system.

Author:

Ibrahim Chaehoi, Stanislaw Osinski

Constructor Summary

Constructors

Constructor and Description
FileSystemResourceHandler(String documentRootDirPath, String charset, MessageLog messageLog) Creates a new FileSystemResourceHandler.

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 baseFile, String filePath) This implementation detects if the resource path starts with a "/" and resolves such resources against the provided SmartSpritesParameters.getDocumentRootDir() directory.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileSystemResourceHandler

public FileSystemResourceHandler(String documentRootDirPath,
                         String charset,
                         MessageLog messageLog)

Creates a new FileSystemResourceHandler.

Parameters:

documentRootDirPath - the document root directory path, can be null

charset - the charset to assume in the getResourceAsReader(String) method

messageLog - the message log

Method Detail

getResourceAsInputStream

public InputStream getResourceAsInputStream(String path)
                                     throws IOException

Description copied from interface: ResourceHandler

Returns the resource input stream for the provided path.

Specified by:

getResourceAsInputStream in interface ResourceHandler

Parameters:

path - the resource path

Returns:

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

Throws:

IOException

getResourceAsReader

public Reader getResourceAsReader(String path)
                           throws IOException

Description copied from interface: ResourceHandler

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

Specified by:

getResourceAsReader in interface ResourceHandler

Parameters:

path - the resource path

Returns:

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

Throws:

IOException

getResourceAsOutputStream

public OutputStream getResourceAsOutputStream(String path)
                                       throws IOException

Description copied from interface: ResourceHandler

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

Specified by:

getResourceAsOutputStream in interface ResourceHandler

Parameters:

path - the resource path

Returns:

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

Throws:

IOException

getResourceAsWriter

public Writer getResourceAsWriter(String path)
                           throws IOException

Description copied from interface: ResourceHandler

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.

Specified by:

getResourceAsWriter in interface ResourceHandler

Parameters:

path - the resource path

Returns:

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

Throws:

IOException

getResourcePath

public String getResourcePath(String baseFile,
                     String filePath)

This implementation detects if the resource path starts with a "/" and resolves such resources against the provided SmartSpritesParameters.getDocumentRootDir() directory.

Specified by:

getResourcePath in interface ResourceHandler

Parameters:

baseFile - the CSS file path (base)

filePath - 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