com.github.wuic.util

Class Pipe<T>

java.lang.Object

com.github.wuic.util.Pipe<T>

Type Parameters:

T - the type of convertible object

public final class Pipe<T>
extends Object

This class helps to chains transformers that read InputStream and writes some transformed bytes to a ByteArrayOutputStream.

Since:

0.5.0

Version:

1.0

Author:

Guillaume DROUET

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Pipe.DefaultOnReady Default implementation which writes the result to a wrapped output stream and close if automatically.
static class	Pipe.DefaultTransformer<T> The default transformer just copies the InputStream to the OutputStream and produces a content which can be aggregated to an other one.
static class	Pipe.Execution This class represents the result of the transformation made by thanks to piped transformers.
static interface	Pipe.OnReady This class represents an object notified when a transformation is done.
static interface	Pipe.Transformer<T> This interface describes an object which is able to write into an OutputStream some transformed bytes read from InputStream.

Constructor Summary

Constructors

Constructor and Description
Pipe(T c, InputStream is) Creates a new instance with an input.

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(Pipe.OnReady... onReady) Executes this pipe by writing a byte array the result generated by all registered transformers.
static <T> void	executeAndWriteTo(Pipe<T> pipe, List<Pipe.OnReady> callbacks, OutputStream os) Executes the given pipe and writes the result into the given OutputStream.
void	register(Pipe.Transformer<T> transformer) Registers the given Pipe.Transformer to the pipe.

Methods inherited from class java.lang.Object

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

Constructor Detail

Pipe

public Pipe(T c,
    InputStream is)

Creates a new instance with an input.

Parameters:

c - the convertible bound to the input stream

is - the InputStream

Method Detail

executeAndWriteTo

public static <T> void executeAndWriteTo(Pipe<T> pipe,
                         List<Pipe.OnReady> callbacks,
                         OutputStream os)
                              throws IOException

Executes the given pipe and writes the result into the given OutputStream.

Type Parameters:

T - the type of object converted by the piped transformers

Parameters:

pipe - the pipe to execute

os - the stream to write

Throws:

IOException - if transformation fails

register

public void register(Pipe.Transformer<T> transformer)
              throws IOException

Registers the given Pipe.Transformer to the pipe. The InputStream sent to this transformer with be connected to the OutputStream of the Pipe.Transformer previously registered.

Parameters:

transformer - the transformer

Throws:

IOException - if streams could not be piped

execute

public void execute(Pipe.OnReady... onReady)
             throws IOException

Executes this pipe by writing a byte array the result generated by all registered transformers.

Once transformation has been done, callback is notified.

Parameters:

onReady - callback

Throws:

IOException - if an I/O error occurs