Class CssPacker


public class CssPacker extends AbstractFilePacker
  • Constructor Details

    • CssPacker

      public CssPacker(String packerDirectory) throws Exception
      Creates a new CSS packer.
      Parameters:
      packerDirectory - the relative path of the servlet/jsp that will be outputing the packed css. MUST be specified.
      Throws:
      IllegalArgumentException - if packerDirectory is null
      Exception - on initialization error
  • Method Details

    • processFileContent

      protected String processFileContent(String cssRelativeFilePath, File cssFile, String cssFileContent)
      Process CSS files' content
      Specified by:
      processFileContent in class AbstractFilePacker
      Parameters:
      cssRelativeFilePath - the relative path of the file being processed
      cssFile - the file being processed
      cssFileContent - the fileContent as read by the AbstractFilePacker
      Returns:
      the processed file content, must not return null.
    • processPackContent

      protected String processPackContent(String packContent)
      Process CSS pack's content
      Specified by:
      processPackContent in class AbstractFilePacker
      Parameters:
      packContent - the whole pack content as computed by the AbstractFilePacker
      Returns:
      the processed pack content, must not return null.
    • postProcessPackContent

      protected String postProcessPackContent(String packContent)
      Move remaining CSS imports to the beginning of the final pack, as required by CSS.
      Overrides:
      postProcessPackContent in class AbstractFilePacker
      Parameters:
      packContent - the whole pack content as computed by the AbstractFilePacker
      Returns:
      the post processed pack content, must not return null.
    • perFileMinificationEnabled

      protected boolean perFileMinificationEnabled()
      Description copied from class: AbstractFilePacker
      Check if minification should be performed on each file as opposed to the whole pack.
      Specified by:
      perFileMinificationEnabled in class AbstractFilePacker
      Returns:
      true to use minified version of individual file, false if minification is disabled or enabled on whole pack
    • getLogger

      protected org.apache.log4j.Logger getLogger()
      Description copied from class: AbstractFilePacker
      Returns the logger to be used for log messages. This methods must be implemented by the file packer.
      Specified by:
      getLogger in class AbstractFilePacker
      Returns:
      Logger of this packer, must not return null.
    • minifyCSS

      public static void minifyCSS(boolean force)
      Create a minified version of all CSS found in JCMS.

      This method only process css file if minification is enabled through property "channel.css-packer.compressor.enabled".
      Only files contained in directories css, plugins and js are processed

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

      public static CheckResult checkAndMinifyCSS(boolean force, boolean isUnittest)
      Create a minified version of all CSS found in JCMS.

      This method only process css file if minification is enabled through property "channel.css-packer.compressor.enabled".
      Only files contained in directories css, plugins and js are processed

      Parameters:
      force - set to true to force generation of minified file even if an up to date apparently exists
      isUnittest - set to true to generate minified file temporarly to check
      Returns:
      an instance of CheckResult, with all minification errors, when unittest was requested and packer successfully created, null otherwise
      Since:
      10.0.9 / JCMS-11077
    • getCSSFilesInPack

      public static Set<String> getCSSFilesInPack(Collection<String> cssFiles, String browserName)
      Returns the set of the URLs created with the CSS packer, respecting the constraints of the browser.
      Parameters:
      cssFiles - collection of CSS files to pack
      browserName - name of the browser used to find the properties 'channel.packer.xxx' defining the limit values. If null, use 'IE' because it's the most constraining.
      Returns:
      Set of the CSS Packer URLs