com.github.wuic.engine.core

Class AbstractCompressorEngine

java.lang.Object

com.github.wuic.engine.Engine

com.github.wuic.engine.NodeEngine

com.github.wuic.engine.core.AbstractCompressorEngine

All Implemented Interfaces:

Pipe.Transformer<ConvertibleNut>, Comparable<Engine>

Direct Known Subclasses:

ImageCompressorEngine

public abstract class AbstractCompressorEngine
extends NodeEngine
implements Pipe.Transformer<ConvertibleNut>

This engine defines the base treatments to execute when compressing a set of files. It could be extended by different sub-classes which provide compression support.

The compression is never performed if the doCompression flag is set to true.

Since:

0.1.0

Version:

1.7

Author:

Guillaume DROUET

Constructor Summary

Constructors

Constructor and Description
AbstractCompressorEngine(Boolean compress, String rnp) Builds a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canAggregateTransformedStream() Indicates if the content generated when Pipe.Transformer.transform(InputStream, OutputStream, Object) is called can be aggregated to an other one.
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, getNutTypes, getPrevious, parse, setNext

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

compareTo, getEngineType

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.util.Pipe.Transformer

transform

Constructor Detail

AbstractCompressorEngine

public AbstractCompressorEngine(Boolean compress,
                        String rnp)

Builds a new instance.

Parameters:

compress - activate compression or not

rnp - the extension prefix used to compute new nut name after compression, null if no extension is managed

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

canAggregateTransformedStream

public boolean canAggregateTransformedStream()

Indicates if the content generated when Pipe.Transformer.transform(InputStream, OutputStream, Object) is called can be aggregated to an other one. This is usually the case but won't be possible for instance when a magic number should appears only at the beginning of the composite stream and not in each stream of the aggregation.

Specified by:

canAggregateTransformedStream in interface Pipe.Transformer<ConvertibleNut>

Returns:

true if aggregation is possible, false otherwise

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