monq.stuff

Class AbstractPipe

java.lang.Object

monq.stuff.AbstractPipe

All Implemented Interfaces:

java.lang.Runnable, Service, Drainer, Feeder

Direct Known Subclasses:

CharSequenceFeeder, DfaRunFeeder, Pipe, ReaderFeeder

public abstract class AbstractPipe
extends java.lang.Object
implements Feeder, Drainer

a skeleton implementation of a combination of Feeder and Drainer. Subclasses only need to implement pipe().

This class implements the run() method required by the Feeder and Drainer interfaces. It calls pipe(), catches any exceptions thrown and closes the provided streams as requested by the 2nd parameters of setOut() and setIn().

Objects of this class may be reused within a single thread as long as setIn() and/or setOut() are called as necessary before each invocation of the run() method.

Half Subclasses

A subclass need not make use of both, input and output. If it generates data, it can choose to only use the output stream provided by setOut(), thereby actually being a Feeder only. A pure data sink, i.e. a Drainer, results if only the provided input stream is used.

Of course such subclasses should then only be used as either Feeder or Drainer such that the unused stream is never set anyway.

Author:

© 2005 Harald Kirsch

Constructor Summary

Constructors

Constructor and Description
AbstractPipe()

Method Summary

Modifier and Type	Method and Description
java.lang.Exception	getException() objects implementing this interface should return any exception worth reporting that happened during run().
void	run() calls pipe(), handles exceptions and closes input and output streams where necessary and requested.
void	setIn(java.io.InputStream in, boolean closeOnExit) specifies the InputStream where to fetch the data in the run() method.
void	setOut(java.io.OutputStream out, boolean closeOnExit) specifies the OutputStream where to deliver the data in the run() method.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPipe

public AbstractPipe()

Method Detail

getException

public java.lang.Exception getException()

Description copied from interface: Service

objects implementing this interface should return any exception worth reporting that happened during run().

Specified by:

getException in interface Service

setOut

public void setOut(java.io.OutputStream out,
                   boolean closeOnExit)

Description copied from interface: Feeder

specifies the OutputStream where to deliver the data in the run() method.

Specified by:

setOut in interface Feeder

closeOnExit - if true, instructs the Feeder to close out before exiting run().

setIn

public void setIn(java.io.InputStream in,
                  boolean closeOnExit)

Description copied from interface: Drainer

specifies the InputStream where to fetch the data in the run() method.

Specified by:

setIn in interface Drainer

closeOnExit - if true, instructs the Drainer to close in before exiting run().

run

public void run()

calls pipe(), handles exceptions and closes input and output streams where necessary and requested.

This method ignores the exceptions InterruptedIOException and InterruptedException when thrown or passed on by pipe()as valid requests to stop operations prematurely.

Specified by:

run in interface java.lang.Runnable