org.jooby.assets

Class AssetAggregator

java.lang.Object

org.jooby.assets.AssetOptions

org.jooby.assets.AssetAggregator

Direct Known Subclasses:

SvgSprites, SvgSymbol

public abstract class AssetAggregator
extends AssetOptions

asset aggregator

Contributes new or dynamically generated content to a fileset. Content generated by an aggregator might be processed by an AssetProcessor.

how to use it?

First thing to do is to add the dependency:

   <dependency>
     <groupId>org.jooby</groupId>
     <artifactId>jooby-assets-dr-svg-sprites</artifactId>
     <scope>provided</scope>
   </dependency>
 

Did you see the provided scope? We just need the aggregator for development, because assets are processed at runtime. For prod, assets are processed at built-time via Maven/Gradle plugin, so we don't need it. This also, helps to keep our dependencies and the jar size small.

Now we have the dependency all we have to do is to add the svg-sprites aggregator to a fileset:

 assets {
   fileset {
     home: [
       // 1) Add the aggregator to a fileset
       svg-sprites,
       css/style.css,
       js/app.js
     ]
   }

   svg-sprites {
     // 2) The `css/sprite.css` file is part of the `home` fileset.
     spritePath: "css/sprite.css"

     spriteElementPath: "images/svg",
   }
 }
 

Here for example, the svg-sprites aggregator contributes the css/sprite.css file to the home fileset. The fileset then looks like:

 assets {
   fileset {
     home: [
       css/sprite.css,
       css/style.css,
       js/app.js
     ]
   }
 }
 

Replaces the aggregator name with one or more files from fileset() method.

Since:

1.0.0

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
AssetAggregator()

Method Summary

Modifier and Type	Method and Description
abstract List<String>	fileset()
String	name()
abstract void	run(com.typesafe.config.Config conf) Run the aggregator and generates some output.
AssetAggregator	set(com.typesafe.config.Config options)
AssetAggregator	set(String name, Object value)
String	toString()

Methods inherited from class org.jooby.assets.AssetOptions

excludes, get, options

Methods inherited from class java.lang.Object

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

Constructor Detail

AssetAggregator

public AssetAggregator()

Method Detail

name

public String name()

Returns:

Aggregator's name.

set

public AssetAggregator set(String name,
                           Object value)

Overrides:

set in class AssetOptions

set

public AssetAggregator set(com.typesafe.config.Config options)

Overrides:

set in class AssetOptions

fileset

public abstract List<String> fileset()

Returns:

The list of generated files contributed by this aggregator.

run

public abstract void run(com.typesafe.config.Config conf)
                  throws Exception

Run the aggregator and generates some output.

Parameters:

conf - Assets conf.

Throws:

Exception - If something goes wrong.

toString

public String toString()

Overrides:

toString in class Object