org.broadleafcommerce.common.resource.service

Interface ResourceMinificationService

All Known Implementing Classes:

ResourceMinificationServiceImpl

public interface ResourceMinificationService

Service responsible for interacting with YUI-compressor to minify JS/CSS resources.

Author:

Andre Azzolini (apazzolini)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getAllowSingleMinification() Indicates whether or not the system is allowed to attempt to minify individual files.
boolean	getEnabled() Indicates whether or not the system is allowed to minify bundled resources.
org.springframework.core.io.Resource	minify(org.springframework.core.io.Resource originalResource) Delegates to minify(Resource, String) where the filename argument is originalResource.getFilename().
org.springframework.core.io.Resource	minify(org.springframework.core.io.Resource originalResource, String filename) Given a Resource, will return a resource that represents the YUI-compressor minified version.
byte[]	minify(String filename, byte[] bytes) Given the source byte[], will return a byte[] that represents the YUI-compressor minified version of the byte[].

Method Detail

minify

byte[] minify(String filename,
            byte[] bytes)

Given the source byte[], will return a byte[] that represents the YUI-compressor minified version of the byte[]. The behavior of this method is controlled via the following properties:

• minify.enabled - whether or not to actually perform minification
• minify.linebreak - if set to a value other than -1, will enforce a linebreak at that value
• minify.munge - if true, will replace variable names with shorter versions
• minify.verbose - if true, will display extra logging information to the console
• minify.preserveAllSemiColons - if true, will never remove semi-colons, even if two in a row exist
• minify.disableOptimizations - if true, will disable some micro-optimizations that are performed

Parameters:

filename -

bytes -

Returns:

the minified bytes

getEnabled

boolean getEnabled()

Indicates whether or not the system is allowed to minify bundled resources.

Returns:

the value of the system property "minify.enabled"

getAllowSingleMinification

boolean getAllowSingleMinification()

Indicates whether or not the system is allowed to attempt to minify individual files. This can be useful if the YUI compressor is failing to minify JavaScript/CSS due to syntax errors and you are attempting to track down which file is problematic. It should not be enabled in a production environment.

Returns:

the value of the system property "minify.allowSingleMinification"

minify

org.springframework.core.io.Resource minify(org.springframework.core.io.Resource originalResource)

Delegates to minify(Resource, String) where the filename argument is originalResource.getFilename().

Parameters:

originalResource -

Returns:

minify

org.springframework.core.io.Resource minify(org.springframework.core.io.Resource originalResource,
                                          String filename)

Given a Resource, will return a resource that represents the YUI-compressor minified version. The behavior of this method is controlled via the following properties:

• minify.enabled - whether or not to actually perform minification
• minify.linebreak - if set to a value other than -1, will enforce a linebreak at that value
• minify.munge - if true, will replace variable names with shorter versions
• minify.verbose - if true, will display extra logging information to the console
• minify.preserveAllSemiColons - if true, will never remove semi-colons, even if two in a row exist
• minify.disableOptimizations - if true, will disable some micro-optimizations that are performed

Parameters:

orginalResource -

the - name of resource

Returns:

The minified resource