com.github.wuic.engine

Class Engine

java.lang.Object

com.github.wuic.engine.Engine

All Implemented Interfaces:

Comparable<Engine>

Direct Known Subclasses:

HeadEngine, NodeEngine

public abstract class Engine
extends Object
implements Comparable<Engine>

An engine is in charge to parse a set of nuts. They are generally able to parse an unique kind of type but the subclass could supports several types.

Engines comparisons is based on their EngineType.

Since:

0.1.0

Version:

1.5

Author:

Guillaume DROUET

Constructor Summary

Constructors

Constructor and Description
Engine()

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Engine other)
abstract EngineType	getEngineType() Gets the type of engine.
protected abstract List<ConvertibleNut>	internalParse(EngineRequest request) Internal method that parses eventually called by NodeEngine.parse(EngineRequest) method during its invocation.
abstract List<ConvertibleNut>	parse(EngineRequest request) Parses the given nuts and returns the result of this operation.
abstract Boolean	works() Returns a flag indicating if the engine is configured to do something or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

Engine

public Engine()

Method Detail

getEngineType

public abstract EngineType getEngineType()

Gets the type of engine.

Returns:

the type of process done by with engine

parse

public abstract List<ConvertibleNut> parse(EngineRequest request)
                                    throws WuicException

Parses the given nuts and returns the result of this operation.

Should throw an IllegalArgumentException the files type is not supported by this Engine.

Parameters:

request - the request with nuts to parse

Returns:

the parsed nuts

Throws:

WuicException - if any kind of error occurs

internalParse

protected abstract List<ConvertibleNut> internalParse(EngineRequest request)
                                               throws WuicException

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

Parameters:

request - the request with files to parse

Returns:

the parsed files

Throws:

WuicException - if any kind of error occurs

works

public abstract Boolean works()

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

Returns:

true is something will be done, false otherwise

compareTo

public final int compareTo(Engine other)

Specified by:

compareTo in interface Comparable<Engine>