net.pwall.util.pipeline

Class AbstractIntObjectPipeline<E,R>

java.lang.Object

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

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

net.pwall.util.pipeline.AbstractIntObjectPipeline<E,R>

Type Parameters:

E - the emitted (downstream) value type

R - the result type

All Implemented Interfaces:

AutoCloseable, BaseAcceptor<R>, IntAcceptor<R>, IntObjectPipeline<E,R>

public abstract class AbstractIntObjectPipeline<E,R>
extends AbstractIntAcceptor<R>
implements IntObjectPipeline<E,R>

Abstract base class for IntObjectPipeline implementations.

Author:

Peter Wall

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractIntObjectPipeline(Acceptor<? super E,? extends R> downstream) Construct an AbstractIntObjectPipeline 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 Acceptor.
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.AbstractIntAcceptor

accept, acceptInt

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.IntAcceptor

accept, accept, accept, accept, accept

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

isClosed

Constructor Detail

AbstractIntObjectPipeline

protected AbstractIntObjectPipeline(Acceptor<? super E,? extends R> downstream)

Construct an AbstractIntObjectPipeline with the given downstream Acceptor.

Parameters:

downstream - the IntAcceptor

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 Acceptor.

Specified by:

emit in interface IntObjectPipeline<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>