com.github.wuic.util

Interface Pipe.Transformer<T>

Type Parameters:

T - the type of convertible object

All Known Implementing Classes:

AbstractCompressorEngine, EngineRequestTransformer, ImageCompressorEngine, Pipe.DefaultTransformer

Enclosing class:

Pipe<T>

public static interface Pipe.Transformer<T>

This interface describes an object which is able to write into an OutputStream some transformed bytes read from InputStream.

When registered with the Pipe, the close method is invoked transparently.

That transformer is also able to change the state of on 'convertible' object identified as the origin of the source input stream.

Since:

0.5.0

Version:

1.0

Author:

Guillaume DROUET

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canAggregateTransformedStream() Indicates if the content generated when transform(InputStream, OutputStream, Object) is called can be aggregated to an other one.
void	transform(InputStream is, OutputStream os, T convertible) Reads the stream and writes the transformed bytes.

Method Detail

transform

void transform(InputStream is,
             OutputStream os,
             T convertible)
               throws IOException

Reads the stream and writes the transformed bytes.

Parameters:

is - the input

os - the output

convertible - the object that provides the original input stream

Throws:

IOException - if an I/O error occurs

canAggregateTransformedStream

boolean canAggregateTransformedStream()

Indicates if the content generated when 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.

Returns:

true if aggregation is possible, false otherwise