io.jstuff.pipeline

Interface BaseAcceptor<R>

Type Parameters:

R - the result type

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

Acceptor<A,R>, BasePipeline<R>, IntAcceptor<R>, IntObjectPipeline<E,R>, IntPipeline<R>, ObjectIntPipeline<A,R>, Pipeline<A,E,R>

All Known Implementing Classes:

AbstractAcceptor, AbstractIntAcceptor, AbstractIntObjectPipeline, AbstractIntPipeline, AbstractObjectIntPipeline, AbstractPipeline, AppendableAcceptor, ASCII_UTF16, Base64Decoder, Base64Encoder, BaseAbstractAcceptor, ByteArrayAcceptor, ByteArrayPipeline, ByteBufferPipeline, CharBufferPipeline, CharSequencePipeline, CodePoint_UTF16, CodePoint_UTF8, Counter, DecoderBase, DecodingPipeline, DynamicDecoder, EncoderBase, EncodingPipeline, ErrorStrategyBase, Filter, Fold, ForkPipeline, HTMLDecoder, HTMLEncoder, IntCounter, IntFilter, ISO8859_1_UTF16, ISO8859_15_UTF16, LinePipeline, ListAcceptor, Mapper, SchemaURIEncoder, SetAcceptor, StringAcceptor, 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 BaseAcceptor<R>
extends AutoCloseable

The base interface for pipeline and acceptor classes.

Author:

Peter Wall

Method Summary

Modifier and Type	Method and Description
default void	flush() Flush the acceptor (required by some implementations - default is a no-operation).
default R	getResult() Get the result of the acceptor.
boolean	isClosed() Return true if the pipeline is closed.
default 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.
default void	safeClose() Close the acceptor, reporting any exceptions as a RuntimeException.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

isClosed

boolean isClosed()

Return true if the pipeline is closed.

Returns:

true if the pipeline is closed

getResult

default R getResult()

Get the result of the acceptor. The default implementation throws an exception.

Returns:

the result

Throws:

UnsupportedOperationException - in all cases

isComplete

default 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. This should be overridden by acceptors that process complex sequences of input.

Returns:

true if the input is in the "complete" state

flush

default void flush()

Flush the acceptor (required by some implementations - default is a no-operation).

safeClose

default void safeClose()

Close the acceptor, reporting any exceptions as a RuntimeException. This avoids having to declare exceptions on each method.

Throws:

RuntimeException - if thrown by close() method