com.github.wuic.engine.core

Class AbstractConverterEngine

java.lang.Object

com.github.wuic.engine.Engine

com.github.wuic.engine.NodeEngine

com.github.wuic.engine.core.AbstractConverterEngine

All Implemented Interfaces:

EngineRequestTransformer.RequireEngineRequestTransformer, Comparable<Engine>

public abstract class AbstractConverterEngine
extends NodeEngine
implements EngineRequestTransformer.RequireEngineRequestTransformer

This engine defines the base treatments to execute when a Nut should by converted from a NutType to another.

When a NutType is changed, the engine chain related to the type is executed and the result is returned. Contrary to engines that instect, the nut won't be added as a referenced nut (ConvertibleNut.getReferencedNuts()).

Since:

0.5.1

Version:

1.0

Author:

Guillaume DROUET

Constructor Summary

Constructors

Constructor and Description
AbstractConverterEngine(Boolean convert, Boolean asynchronous) Builds a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
EngineType	getEngineType() Gets the type of engine.
List<ConvertibleNut>	internalParse(EngineRequest request) Internal method that parses eventually called by NodeEngine.parse(EngineRequest) method during its invocation.
protected abstract NutType	targetNutType() Returns the NutType corresponding to the converted nut.
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, getNutTypes, 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

Methods inherited from interface com.github.wuic.engine.core.EngineRequestTransformer.RequireEngineRequestTransformer

transform

Constructor Detail

AbstractConverterEngine

public AbstractConverterEngine(Boolean convert,
                       Boolean asynchronous)

Builds a new instance.

Parameters:

convert - activate compression or not

asynchronous - computes asynchronously the version number or not

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

getEngineType

public final 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

targetNutType

protected abstract NutType targetNutType()

Returns the NutType corresponding to the converted nut.

Returns:

the target type