com.github.wuic.engine.core

Class StaticEngine

java.lang.Object

com.github.wuic.engine.Engine

com.github.wuic.engine.NodeEngine

com.github.wuic.engine.core.StaticEngine

All Implemented Interfaces:

Comparable<Engine>

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

This engine should be used for non-dynamic WUIC features. Actually, static means that WUIC is not able to access nuts. This engine considers that nuts have been already processed and that their links are stored in a file inside the classpath. This file should be generated at build time with the maven plugin.

When this engine is called, it just looks for nuts paths and then return it. If file that contains nuts path has not been found, then an exception is thrown. Consequently, the engine won't call any next engine in the chain of responsibility.

Since:

0.4.1

Version:

1.1

Author:

Guillaume DROUET

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	PATTERN_KEY_VALUE Pattern that matches a key/value pair pattern.
static String	STATIC_WORKFLOW_FILE File pattern.

Constructor Summary

Constructors

Constructor and Description
StaticEngine() Builds a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
EngineType	getEngineType() Gets the type of engine.
List<NutType>	getNutTypes() Gets the all types supported by this engine.
protected 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

callNextEngine, 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

Field Detail

STATIC_WORKFLOW_FILE

public static final String STATIC_WORKFLOW_FILE

File pattern.

See Also:

Constant Field Values

PATTERN_KEY_VALUE

public static final Pattern PATTERN_KEY_VALUE

Pattern that matches a key/value pair pattern. One key/value pair per line is detected.

Constructor Detail

StaticEngine

@ConfigConstructor
public StaticEngine()

Builds a new instance.

Method Detail

internalParse

protected 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

getEngineType

public EngineType getEngineType()

Gets the type of engine.

Specified by:

getEngineType in class Engine

Returns:

the type of process done by with engine

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