com.github.wuic.engine.core

Class GzipEngine

java.lang.Object

com.github.wuic.engine.Engine

com.github.wuic.engine.NodeEngine

com.github.wuic.engine.core.GzipEngine

All Implemented Interfaces:

Comparable<Engine>

Direct Known Subclasses:

ServletGzipEngine

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

This engine GZIP nut content.

Since:

0.5.0

Version:

1.0

Author:

Guillaume DROUET

Constructor Summary

Constructors

Constructor and Description
GzipEngine(Boolean compress) 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

Constructor Detail

GzipEngine

@ConfigConstructor
public GzipEngine(@BooleanConfigParam(propertyKey="c.g.wuic.engine.compress",defaultValue=true)
                            Boolean compress)

Builds a new instance.

Parameters:

compress - compress or not

Method Detail

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

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

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