com.github.wuic.engine.core

Class SpriteInspectorEngine

java.lang.Object

com.github.wuic.engine.Engine

com.github.wuic.engine.NodeEngine

com.github.wuic.engine.core.SpriteInspectorEngine

All Implemented Interfaces:

Comparable<Engine>

@EngineService(injectDefaultToWorkflow=true,
               isCoreEngine=true)
public class SpriteInspectorEngine
extends NodeEngine

This engine computes sprites for a set of images. It let the next engine do their job and get the result to analyze a potential aggregated image.

Since:

0.4.4

Version:

1.0

Author:

Guillaume DROUET

Constructor Summary

Constructors

Constructor and Description
SpriteInspectorEngine(Boolean inspect, SpriteProvider[] sp) Builds a new aggregator engine.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	callNextEngine() Indicates if the next engine should be called by the base class or if this responsibility is delegated to the subclass.
EngineType	getEngineType() Gets the type of engine.
List<NutType>	getNutTypes() Gets the all types supported by this engine.
List<ConvertibleNut>	internalParse(EngineRequest request) Internal method that parses eventually called by NodeEngine.parse(EngineRequest) method during its invocation.
Boolean	works() Returns a flag indicating if the engine is configured to do something or not.

Methods inherited from class com.github.wuic.engine.NodeEngine

chain, getNext, getPrevious, parse, setNext

Methods inherited from class com.github.wuic.engine.Engine

compareTo

Methods inherited from class java.lang.Object

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

Constructor Detail

SpriteInspectorEngine

@ConfigConstructor
public SpriteInspectorEngine(@BooleanConfigParam(defaultValue=true,propertyKey="c.g.wuic.engine.inspect")
                                       Boolean inspect,
                                       @ObjectConfigParam(defaultValue="css",propertyKey="c.g.wuic.engine.spriteProviderClassName",setter=SpriteProviderPropertySetter.class)
                                       SpriteProvider[] sp)

Builds a new aggregator engine.

Parameters:

inspect - if inspect or not

sp - the provider which generates sprites

Method Detail

internalParse

public List<ConvertibleNut> internalParse(EngineRequest request)
                                   throws WuicException

Internal method that parses eventually called by NodeEngine.parse(EngineRequest) method during its invocation.

Specified by:

internalParse in class Engine

Parameters:

request - the request with files to parse

Returns:

the parsed files

Throws:

WuicException - if any kind of error occurs

getNutTypes

public List<NutType> getNutTypes()

Gets the all types supported by this engine.

Specified by:

getNutTypes in class NodeEngine

Returns:

the NutType

works

public Boolean works()

Returns a flag indicating if the engine is configured to do something or not.

Specified by:

works in class Engine

Returns:

true is something will be done, false otherwise

getEngineType

public EngineType getEngineType()

Gets the type of engine.

Specified by:

getEngineType in class Engine

Returns:

the type of process done by with engine

callNextEngine

protected boolean callNextEngine()

Indicates if the next engine should be called by the base class or if this responsibility is delegated to the subclass.

Overrides:

callNextEngine in class NodeEngine

Returns:

true if NodeEngine is responsible of calling next engine, false otherwise