io.jstuff.pipeline

Interface BasePipeline<R>

Type Parameters:

R - the result type

All Superinterfaces:

AutoCloseable, BaseAcceptor<R>

All Known Subinterfaces:

IntObjectPipeline<E,R>, IntPipeline<R>, ObjectIntPipeline<A,R>, Pipeline<A,E,R>

All Known Implementing Classes:

AbstractIntObjectPipeline, AbstractIntPipeline, AbstractObjectIntPipeline, AbstractPipeline, ASCII_UTF16, Base64Decoder, Base64Encoder, ByteArrayPipeline, ByteBufferPipeline, CharBufferPipeline, CharSequencePipeline, CodePoint_UTF16, CodePoint_UTF8, DecoderBase, DecodingPipeline, DynamicDecoder, EncoderBase, EncodingPipeline, ErrorStrategyBase, Filter, ForkPipeline, HTMLDecoder, HTMLEncoder, IntFilter, ISO8859_1_UTF16, ISO8859_15_UTF16, LinePipeline, Mapper, SchemaURIEncoder, SwitchableDecoder, URIDecoder, URIEncoder, UTF16_ASCII, UTF16_CodePoint, UTF16_ISO8859_1, UTF16_ISO8859_15, UTF16_Windows1252, UTF16BE_UTF16, UTF16LE_UTF16, UTF32BE_CodePoint, UTF32LE_CodePoint, UTF8_CodePoint, UTF8_UTF16, Windows1252_UTF16, XMLDecoder, XMLEncoder

public interface BasePipeline<R>
extends BaseAcceptor<R>

Base interface for pipeline classes.

Author:

Peter Wall

Method Summary

Modifier and Type	Method and Description
BaseAcceptor<? extends R>	getDownstream() Get the downstream BaseAcceptor.
default R	getResult() Get the result object (defaults to the result of the downstream acceptor).
default boolean	isComplete() Return true if all sequences in the input are complete, both for the current stage and for the downstream stages.
default boolean	isStageComplete() Return true if all sequences in the input to this stage of the pipeline are complete, that is, the input is not in the middle of a sequence requiring more data.

Methods inherited from interface io.jstuff.pipeline.BaseAcceptor

flush, isClosed, safeClose

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

getDownstream

BaseAcceptor<? extends R> getDownstream()

Get the downstream BaseAcceptor.

Returns:

the BaseAcceptor

isStageComplete

default boolean isStageComplete()

Return true if all sequences in the input to this stage of the pipeline are complete, that is, the input is not in the middle of a sequence requiring more data. This should be overridden by pipeline stages that process complex sequences of input.

Returns:

true if the input is in the "complete" state

isComplete

default boolean isComplete()

Return true if all sequences in the input are complete, both for the current stage and for the downstream stages.

Specified by:

isComplete in interface BaseAcceptor<R>

Returns:

true if the input is in the "complete" state

getResult

default R getResult()

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

Specified by:

getResult in interface BaseAcceptor<R>

Returns:

the result

Throws:

IllegalStateException - if there is an incomplete sequence in progress