org.carrot2.labs.smartsprites

Class SpriteBuilder

java.lang.Object

org.carrot2.labs.smartsprites.SpriteBuilder

public class SpriteBuilder
extends Object

Performs all stages of sprite building. This class is not thread-safe.

Field Summary

Fields

Modifier and Type	Field and Description
SmartSpritesParameters	parameters This builder's configuration

Constructor Summary

Constructors

Constructor and Description
SpriteBuilder(SmartSpritesParameters parameters, MessageLog messageLog) Creates a SpriteBuilder with the provided parameters and log.
SpriteBuilder(SmartSpritesParameters parameters, MessageLog messageLog, ResourceHandler resourceHandler) Creates a SpriteBuilder with the provided parameters and log.

Method Summary

Methods

Modifier and Type	Method and Description
void	buildSprites() Performs processing for this builder's parameters.
void	buildSprites(Collection<String> filePaths) Performs processing from the list of file paths for this builder's parameters.

Methods inherited from class java.lang.Object

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

Field Detail

parameters

public final SmartSpritesParameters parameters

This builder's configuration

Constructor Detail

SpriteBuilder

public SpriteBuilder(SmartSpritesParameters parameters,
             MessageLog messageLog)

Creates a SpriteBuilder with the provided parameters and log.

SpriteBuilder

public SpriteBuilder(SmartSpritesParameters parameters,
             MessageLog messageLog,
             ResourceHandler resourceHandler)

Creates a SpriteBuilder with the provided parameters and log.

Method Detail

buildSprites

public void buildSprites()
                  throws FileNotFoundException,
                         IOException

Performs processing for this builder's parameters. This method resolves all paths against the local file system.

Throws:

FileNotFoundException

IOException

buildSprites

public void buildSprites(Collection<String> filePaths)
                  throws FileNotFoundException,
                         IOException

Performs processing from the list of file paths for this builder's parameters.

Parameters:

filePaths - paths of CSS files to process. Non-absolute paths will be taken relative to the current working directory. Both platform-specific and '/' as the file separator are supported.

Throws:

FileNotFoundException

IOException