com.github.wuic.engine.core

Class ImageCompressorEngine

java.lang.Object

com.github.wuic.engine.Engine

com.github.wuic.engine.NodeEngine

com.github.wuic.engine.core.AbstractCompressorEngine

com.github.wuic.engine.core.ImageCompressorEngine

All Implemented Interfaces:

Pipe.Transformer<ConvertibleNut>, Comparable<Engine>

@EngineService(injectDefaultToWorkflow=true,
               isCoreEngine=true)
public class ImageCompressorEngine
extends AbstractCompressorEngine

Engine that compress images. Currently do nothing but could be completed in future enhancement.

Since:

0.2.0

Version:

1.4

Author:

Guillaume DROUET

Constructor Summary

Constructors

Constructor and Description
ImageCompressorEngine(Boolean compress) Creates a new Engine.

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.
EngineType	getEngineType() Gets the type of engine.
List<NutType>	getNutTypes() Gets the all types supported by this engine.
void	transform(InputStream source, OutputStream target, ConvertibleNut nut) Reads the stream and writes the transformed bytes.

Methods inherited from class com.github.wuic.engine.core.AbstractCompressorEngine

internalParse, works

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

ImageCompressorEngine

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

Creates a new Engine.

Parameters:

compress - activate compression or not

Method Detail

transform

public void transform(InputStream source,
             OutputStream target,
             ConvertibleNut nut)
               throws IOException

Reads the stream and writes the transformed bytes.

Parameters:

source - the input

target - the output

nut - the object that provides the original input stream

Throws:

IOException - if an I/O 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>

Overrides:

canAggregateTransformedStream in class AbstractCompressorEngine

Returns:

true if aggregation is possible, false otherwise

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