net.pwall.util.pipeline

Class AbstractPipeline<A,E,R>

java.lang.Object

net.pwall.util.pipeline.BaseAbstractAcceptor<R>

net.pwall.util.pipeline.AbstractAcceptor<A,R>

net.pwall.util.pipeline.AbstractPipeline<A,E,R>

Type Parameters:

A - the accepted (input) value type

E - the emitted (downstream) value type

R - the result type

All Implemented Interfaces:

AutoCloseable, Acceptor<A,R>, BaseAcceptor<R>, Pipeline<A,E,R>

public abstract class AbstractPipeline<A,E,R>
extends AbstractAcceptor<A,R>
implements Pipeline<A,E,R>

Abstract implementation of Pipeline.

Author:

Peter Wall

Constructor Summary

Constructors

Constructor and Description
AbstractPipeline(Acceptor<? super E,? extends R> downstream) Construct an AbstractPipeline with the given downstream Acceptor.

Method Summary

Modifier and Type	Method and Description
void	close() Close the pipeline.
void	emit(E value) Emit a value to the downstream IntAcceptor.
void	flush() Propagate the flush operation to the downstream acceptor.
R	getResult() Get the result object (defaults to the result of the downstream acceptor).
boolean	isComplete() Return true if all sequences in the input are complete, that is, the input is not in the middle of a sequence requiring more data.

Methods inherited from class net.pwall.util.pipeline.AbstractAcceptor

accept, acceptObject

Methods inherited from class net.pwall.util.pipeline.BaseAbstractAcceptor

isClosed

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.pwall.util.pipeline.Acceptor

accept

Methods inherited from interface net.pwall.util.pipeline.BaseAcceptor

isClosed

Constructor Detail

AbstractPipeline

public AbstractPipeline(Acceptor<? super E,? extends R> downstream)

Construct an AbstractPipeline with the given downstream Acceptor.

Parameters:

downstream - the Acceptor

Method Detail

close

public void close()
           throws Exception

Close the pipeline.

Specified by:

close in interface AutoCloseable

Overrides:

close in class BaseAbstractAcceptor<R>

Throws:

Exception - if the acceptor is not in the "complete" state

emit

public void emit(E value)
          throws Exception

Emit a value to the downstream IntAcceptor.

Specified by:

emit in interface Pipeline<A,E,R>

Parameters:

value - the value to be forwarded

Throws:

Exception - if thrown by a close() method

getResult

public R getResult()

Get the result object (defaults to the result of the downstream acceptor).

Specified by:

getResult in interface BaseAcceptor<R>

Overrides:

getResult in class BaseAbstractAcceptor<R>

Returns:

the result

isComplete

public boolean isComplete()

Return true if all sequences in the input are complete, that is, the input is not in the middle of a sequence requiring more data. The default implementation tests whether the downstream acceptor is complete.

Specified by:

isComplete in interface BaseAcceptor<R>

Returns:

true if the input is in the "complete" state

flush

public void flush()

Propagate the flush operation to the downstream acceptor.

Specified by:

flush in interface BaseAcceptor<R>