org.jooby.assets

Class AssetCompiler

java.lang.Object

org.jooby.assets.AssetCompiler

public class AssetCompiler
extends Object

Asset compiler

Process static files by validate or modify them in some way.

Since:

0.11.0

Author:

edgar

See Also:

AssetProcessor, Assets

Constructor Summary

Constructors

Constructor and Description
AssetCompiler(ClassLoader loader, com.typesafe.config.Config conf)
AssetCompiler(com.typesafe.config.Config conf)

Method Summary

Modifier and Type	Method and Description
List<AssetAggregator>	aggregators()
List<String>	assets(String name) Get all the assets for the provided file set.
Asset	build(Asset asset) Apply the processor pipeline to the given asset.
Map<String,List<File>>	build(String dist, File dir) Build assets using the given distribution and write output to the provided directory.
boolean	contains(String path) Test if the provided path is part of the fileset.
Set<String>	fileset()
Set<String>	patterns() Iterate over fileset and common path pattern for them.
List<AssetProcessor>	pipeline(String dist) List all the AssetProcessor for a distribution (a.k.a.
List<String>	scripts(String fileset) Get all the javascript (or derived) for the provided fileset.
List<String>	styles(String fileset) Get all the css files (or derived) for the provided fileset.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AssetCompiler

public AssetCompiler(com.typesafe.config.Config conf)
              throws Exception

Throws:

Exception

AssetCompiler

public AssetCompiler(ClassLoader loader,
                     com.typesafe.config.Config conf)
              throws Exception

Throws:

Exception

Method Detail

assets

public List<String> assets(String name)

Get all the assets for the provided file set. Example:

 assets {
   fileset {
     home: [home.css, home.js]
   }
 }
 

This method returns home.css and home.js for home file set. If there is no fileset under that name then it returns an empty list.

Parameters:

name - Fileset name.

Returns:

List of files or empty list.

fileset

public Set<String> fileset()

Returns:

Returns all the fileset.

patterns

public Set<String> patterns()

Iterate over fileset and common path pattern for them. Example:

 {
   assets {
     fileset {
       lib: [js/lib/jquery.js],
       home: [css/style.css, js/home.js]
     }
   }
 }
 

This method returns a set with /css/** and /js/** pattern.

Returns:

Path pattern of the entire fileset.

contains

public boolean contains(String path)

Test if the provided path is part of the fileset.

Parameters:

path - Test to test.

Returns:

True, if the path belong to the filset.

scripts

public List<String> scripts(String fileset)

Get all the javascript (or derived) for the provided fileset. Example:

 {
   assets {
     fileset {
       mypage: [mypage.js, mypage.css]
     }
   }
 }
 

This method returns mypage.js for mypage fileset.

Parameters:

fileset - Fileset name.

Returns:

All the scripts for a fileset.

styles

public List<String> styles(String fileset)

Get all the css files (or derived) for the provided fileset. Example:

 {
   assets {
     fileset {
       mypage: [mypage.js, mypage.css]
     }
   }
 }
 

This method returns mypage.js for mypage fileset.

Parameters:

fileset - Fileset name.

Returns:

All the scripts for a fileset.

pipeline

public List<AssetProcessor> pipeline(String dist)

List all the AssetProcessor for a distribution (a.k.a. environment).

Parameters:

dist - Distribution's name.

Returns:

A readonly list of available AssetProcessor.

aggregators

public List<AssetAggregator> aggregators()

Returns:

Readonly list of available AssetAggregator.

build

public Map<String,List<File>> build(String dist,
                                    File dir)
                             throws Exception

Build assets using the given distribution and write output to the provided directory. Build process is defined as follow: 1. First, it runs all the aggregators (if any) 2. Then iterates each fileset and per each file in the fileset it apply the processor pipeline. 3. Finally, it merge all the files into one file and compressed/optimized if need it.

Parameters:

dist - Distribution's name (usually dev or dist).

dir - Output directory.

Returns:

Map with fileset name as key and list of generated assets.

Throws:

Exception - If something goes wrong.

build

public Asset build(Asset asset)
            throws Exception

Apply the processor pipeline to the given asset. Like build(String, File) but for a single file or asset.

Parameters:

asset - Asset to build.

Returns:

Processed asset.

Throws:

Exception - If something goes wrong.

toString

public String toString()

Overrides:

toString in class Object