org.carrot2.labs.smartsprites

Class SmartSpritesParameters

java.lang.Object

org.carrot2.labs.smartsprites.SmartSpritesParameters

public final class SmartSpritesParameters
extends Object

Contains invocation parameters for SmartSprites, provides methods for validating the parameters.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SmartSpritesParameters.PngDepth

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CSS_FILE_ENCODING By default, we'll assume CSS files are UTF-8 encoded
static String	DEFAULT_CSS_FILE_SUFFIX The default suffix to be added to the generated CSS files.
static Message.MessageLevel	DEFAULT_LOGGING_LEVEL The default logging level.
static SmartSpritesParameters.PngDepth	DEFAULT_SPRITE_PNG_DEPTH By default, we use full color only when necessary
static boolean	DEFAULT_SPRITE_PNG_IE6 By default, we don't generate separate sprites for IE6

Constructor Summary

Constructors

Constructor and Description
SmartSpritesParameters() Creates the parameters with default options and null root dir, before root dir is set, the parameters are invalid.
SmartSpritesParameters(String rootDir) Creates the parameters with most default values.
SmartSpritesParameters(String rootDir, List<String> cssFiles, String outputDir, String documentRootDir, Message.MessageLevel logLevel, String cssFileSuffix, SmartSpritesParameters.PngDepth spritePngDepth, boolean spritePngIe6, String cssEncoding) Creates the parameters.

Method Summary

Methods

Modifier and Type	Method and Description
String	getCssFileEncoding()
List<String>	getCssFiles()
String	getCssFileSuffix()
String	getDocumentRootDir()
Message.MessageLevel	getLogLevel()
String	getOutputDir()
String	getRootDir()
File	getRootDirFile()
SmartSpritesParameters.PngDepth	getSpritePngDepth()
boolean	hasCssFiles()
boolean	hasDocumentRootDir()
boolean	hasOutputDir()
boolean	hasRootDir()
boolean	isSpritePngIe6()
boolean	validate(MessageLog log) Validates the provided parameters.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CSS_FILE_SUFFIX

public static final String DEFAULT_CSS_FILE_SUFFIX

The default suffix to be added to the generated CSS files.

See Also:

Constant Field Values

DEFAULT_SPRITE_PNG_DEPTH

public static final SmartSpritesParameters.PngDepth DEFAULT_SPRITE_PNG_DEPTH

By default, we use full color only when necessary

DEFAULT_SPRITE_PNG_IE6

public static final boolean DEFAULT_SPRITE_PNG_IE6

By default, we don't generate separate sprites for IE6

See Also:

Constant Field Values

DEFAULT_CSS_FILE_ENCODING

public static final String DEFAULT_CSS_FILE_ENCODING

By default, we'll assume CSS files are UTF-8 encoded

See Also:

Constant Field Values

DEFAULT_LOGGING_LEVEL

public static final Message.MessageLevel DEFAULT_LOGGING_LEVEL

The default logging level.

Constructor Detail

SmartSpritesParameters

public SmartSpritesParameters()

Creates the parameters with default options and null root dir, before root dir is set, the parameters are invalid.

SmartSpritesParameters

public SmartSpritesParameters(String rootDir)

Creates the parameters with most default values.

SmartSpritesParameters

public SmartSpritesParameters(String rootDir,
                      List<String> cssFiles,
                      String outputDir,
                      String documentRootDir,
                      Message.MessageLevel logLevel,
                      String cssFileSuffix,
                      SmartSpritesParameters.PngDepth spritePngDepth,
                      boolean spritePngIe6,
                      String cssEncoding)

Creates the parameters.

Method Detail

validate

public boolean validate(MessageLog log)

Validates the provided parameters. All resource paths are resolved agains the local file system.

Returns:

true if the parameters are valid

getRootDir

public String getRootDir()

getRootDirFile

public File getRootDirFile()
                    throws IOException

Throws:

IOException

hasRootDir

public boolean hasRootDir()

getCssFiles

public List<String> getCssFiles()

hasCssFiles

public boolean hasCssFiles()

getOutputDir

public String getOutputDir()

hasOutputDir

public boolean hasOutputDir()

getDocumentRootDir

public String getDocumentRootDir()

hasDocumentRootDir

public boolean hasDocumentRootDir()

getLogLevel

public Message.MessageLevel getLogLevel()

getCssFileSuffix

public String getCssFileSuffix()

getSpritePngDepth

public SmartSpritesParameters.PngDepth getSpritePngDepth()

isSpritePngIe6

public boolean isSpritePngIe6()

getCssFileEncoding

public String getCssFileEncoding()