com.jalios.jcms.tools

Class AbstractFilePacker

java.lang.Object

com.jalios.jcms.tools.AbstractFilePacker

Direct Known Subclasses:

CssPacker, JsPacker

public abstract class AbstractFilePacker
extends java.lang.Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFilePacker(java.lang.String extension) Builds a new file packer using specified options.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getFilePack(java.lang.String[] relativeFilePaths) Packs specified files into one and single string.
java.io.File	getMinifiedFile(java.io.File cssOrJsFile, java.lang.String relativeFilePath) Retrieve the minified File associated to the specified CSS or JS file.
boolean	minifyFile(java.io.File cssOrJsFile, boolean force) Minify the specified CSS file into a compress version if it does not already exists in an up to date version.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFilePacker

protected AbstractFilePacker(java.lang.String extension)
                      throws java.io.IOException

Builds a new file packer using specified options.

Parameters:

extension - file extension required to pack file

Throws:

java.io.IOException

Method Detail

getFilePack

public java.lang.String getFilePack(java.lang.String[] relativeFilePaths)

Packs specified files into one and single string.

Parameters:

relativeFilePaths - an array of path relative to the webapp directory

Returns:

a String containing path of all files to pack.

getMinifiedFile

public java.io.File getMinifiedFile(java.io.File cssOrJsFile,
                           java.lang.String relativeFilePath)

Retrieve the minified File associated to the specified CSS or JS file.

Example : If new File("/test/foobar.css"); is specified as parameter, this method will return new File("/WEB-INF/jcmswork/min.css/test/foobar.css");

This method does not create the file, it simply retrieve the File instance.

Parameters:

cssOrJsFile - a valid CSS or JS file

relativeFilePath - the path of the CSS or JS file relative to the webapp root

Returns:

a new File instance

minifyFile

public boolean minifyFile(java.io.File cssOrJsFile,
                 boolean force)

Minify the specified CSS file into a compress version if it does not already exists in an up to date version.

For example, if new File("/test/foobar.min.css"); is specified as parameter, this checks if new File("/test/foobar.min.css"); (as returned by getMinifiedFile(File, String)) exists and is up to date, if it is not it will create it.

Parameters:

cssOrJsFile - the CSS File to compress

force - set to true to force generation of minified file even if an up to date apparently exists

Returns:

true if File was minified, false otherwise