com.github.wuic.engine

Class HeadEngine

java.lang.Object

com.github.wuic.engine.Engine

com.github.wuic.engine.HeadEngine

All Implemented Interfaces:

Comparable<Engine>

Direct Known Subclasses:

AbstractCacheEngine

public abstract class HeadEngine
extends Engine

Represents an Engine that could be the head of a chain of responsibility. This engine can parse a request containing ConvertibleNut of different type and provides the way to access to a particular nut of a process result.

The particular Engine essentially exists to expose specific features from cache support.

Since:

0.4.4

Version:

1.0

Author:

Guillaume DROUET

Constructor Summary

Constructors

Constructor and Description
HeadEngine()

Method Summary

Methods

Modifier and Type	Method and Description
List<ConvertibleNut>	parse(EngineRequest request) Parses the given nuts and returns the result of this operation.
abstract ConvertibleNut	parse(EngineRequest request, String path) Parses the given request and returns the nut associated to the given path.
static List<ConvertibleNut>	runChains(EngineRequest request) This method parses the sequences of ConvertibleNut of the same type and aggregates the nuts with same names between the results.

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

compareTo, getEngineType, internalParse, works

Methods inherited from class java.lang.Object

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

Constructor Detail

HeadEngine

public HeadEngine()

Method Detail

parse

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

Specified by:

parse in class Engine

Parameters:

request - the request with nuts to parse

Returns:

the parsed nuts

Throws:

WuicException - if any kind of error occurs

runChains

public static List<ConvertibleNut> runChains(EngineRequest request)
                                      throws WuicException

This method parses the sequences of ConvertibleNut of the same type and aggregates the nuts with same names between the results.

Parameters:

request - the request providing engine chains

Returns:

the process result

Throws:

WuicException - if WUIC fails to process nuts

parse

public abstract ConvertibleNut parse(EngineRequest request,
                   String path)
                              throws WuicException

Parses the given request and returns the nut associated to the given path.

Parameters:

request - the request

path - the nut name

Returns:

the associated nut

Throws:

WuicException - if request could not be executed successfully