Module org.refcodes.codec

Package org.refcodes.codec

Class BaseDecoderImpl

java.lang.Object

org.refcodes.component.AbstractConnectableAutomaton

org.refcodes.codec.BaseDecoderImpl

All Implemented Interfaces:

BaseDecoder, BaseMetricsAccessor, BaseMetricsAccessor.BaseCodecMetricsProperty, BaseMetricsAccessor.BaseMetricsBuilder<BaseDecoder>, BaseMetricsAccessor.BaseMetricsMutator, Decoder, org.refcodes.component.Closable, org.refcodes.component.Closable.CloseAutomaton, org.refcodes.component.ClosedAccessor, org.refcodes.component.ConnectableComponent, org.refcodes.component.ConnectableComponent.ConnectableAutomaton, org.refcodes.component.ConnectionStatusAccessor, org.refcodes.component.OpenedAccessor, org.refcodes.io.Availability, org.refcodes.io.ByteDestination, org.refcodes.io.ByteReceiver, org.refcodes.io.BytesDestination, org.refcodes.io.BytesReceiver, org.refcodes.io.Receivable, org.refcodes.io.Skippable, org.refcodes.io.TimeoutInputStreamAccessor, org.refcodes.mixin.InputStreamAccessor

Direct Known Subclasses:

BaseDecoderImpl.BaseDecoderConnectionImpl, BaseInputStreamDecoder

public class BaseDecoderImpl
extends org.refcodes.component.AbstractConnectableAutomaton
implements BaseDecoder

Vanilla plain implementation of the BaseDecoder interface to be used with BytesReceiver instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BaseDecoderImpl.BaseDecoderConnectionImpl	Vanilla plain implementation of the BaseDecoder.BaseDecoderConnection interface to be used with BytesDestination (BytesReceiver) instances.

Nested classes/interfaces inherited from interface org.refcodes.codec.BaseDecoder

BaseDecoder.BaseDecoderConnection

Nested classes/interfaces inherited from interface org.refcodes.codec.BaseMetricsAccessor

BaseMetricsAccessor.BaseCodecMetricsProperty, BaseMetricsAccessor.BaseMetricsBuilder<B extends BaseMetricsAccessor.BaseMetricsBuilder<B>>, BaseMetricsAccessor.BaseMetricsMutator

Nested classes/interfaces inherited from interface org.refcodes.io.BytesReceiver

org.refcodes.io.BytesReceiver.ReceiverInputStream

Nested classes/interfaces inherited from interface org.refcodes.component.Closable

org.refcodes.component.Closable.CloseAutomaton, org.refcodes.component.Closable.CloseBuilder<B extends org.refcodes.component.Closable.CloseBuilder<B>>

Nested classes/interfaces inherited from interface org.refcodes.component.ClosedAccessor

org.refcodes.component.ClosedAccessor.ClosedMutator, org.refcodes.component.ClosedAccessor.ClosedProperty

Nested classes/interfaces inherited from interface org.refcodes.component.ConnectableComponent

org.refcodes.component.ConnectableComponent.ConnectableAutomaton

Nested classes/interfaces inherited from interface org.refcodes.component.ConnectionStatusAccessor

org.refcodes.component.ConnectionStatusAccessor.ConnectionStatusMutator, org.refcodes.component.ConnectionStatusAccessor.ConnectionStatusProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.InputStreamAccessor

org.refcodes.mixin.InputStreamAccessor.InputStreamBuilder<B extends org.refcodes.mixin.InputStreamAccessor.InputStreamBuilder<?>>, org.refcodes.mixin.InputStreamAccessor.InputStreamMutator, org.refcodes.mixin.InputStreamAccessor.InputStreamProperty

Nested classes/interfaces inherited from interface org.refcodes.component.OpenedAccessor

org.refcodes.component.OpenedAccessor.OpenedMutator, org.refcodes.component.OpenedAccessor.OpenedProperty

Nested classes/interfaces inherited from interface org.refcodes.io.TimeoutInputStreamAccessor

org.refcodes.io.TimeoutInputStreamAccessor.TimeoutInputStreamBuilder<B extends org.refcodes.io.TimeoutInputStreamAccessor.TimeoutInputStreamBuilder<?>>, org.refcodes.io.TimeoutInputStreamAccessor.TimeoutInputStreamMutator, org.refcodes.io.TimeoutInputStreamAccessor.TimeoutInputStreamProperty

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseDecoderImpl()	Explicit default constructor.
	BaseDecoderImpl(org.refcodes.io.BytesDestination aByteProvider)	Constructs the BaseDecoder reading the data to be decoded from the provided BytesDestination.
	BaseDecoderImpl(org.refcodes.io.BytesReceiver aByteReceiver)	Constructs the BaseDecoder reading the data to be decoded from the provided BytesReceiver.

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
BaseMetrics	getBaseMetrics()	Retrieves the base codec metrics from the base codec metrics property.
protected void	open(org.refcodes.io.BytesDestination aConnection)	Open.
byte[]	receiveAllBytes()
byte	receiveByte()
void	setBaseMetrics(BaseMetrics aBaseMetrics)	Sets the base codec metrics for the base codec metrics property.
BaseDecoder	withBaseMetrics(BaseMetrics aBaseMetrics)	Sets the base codec metrics for the base codec metrics property.

Methods inherited from class org.refcodes.component.AbstractConnectableAutomaton

getConnectionStatus, isClosable, isClosed, isOpenable, isOpened, open, setConnectionStatus

Methods inherited from interface org.refcodes.io.Availability

hasAvailable

Methods inherited from interface org.refcodes.codec.BaseMetricsAccessor.BaseCodecMetricsProperty

letBaseMetrics

Methods inherited from interface org.refcodes.io.BytesDestination

receiveBytes

Methods inherited from interface org.refcodes.io.BytesReceiver

getInputStream, getInputStream, receiveBytes, receiveBytesWithin, receiveBytesWithin, receiveByteWithin, skip

Methods inherited from interface org.refcodes.component.Closable

closeIn, closeQuietly, closeUnchecked

Methods inherited from interface org.refcodes.component.Closable.CloseAutomaton

isClosable

Methods inherited from interface org.refcodes.component.ClosedAccessor

isClosed

Methods inherited from interface org.refcodes.component.ConnectionStatusAccessor

getConnectionStatus, isOpened

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.io.Skippable

skipAvailable, skipAvailableExcept, skipAvailableTill, skipAvailableTillSilenceFor, skipAvailableTillSilenceFor, skipAvailableWithin, skipAvailableWithin

Constructor Detail

BaseDecoderImpl

public BaseDecoderImpl(org.refcodes.io.BytesDestination aByteProvider)

Constructs the BaseDecoder reading the data to be decoded from the provided BytesDestination.

Parameters:

aByteProvider - The BytesDestination from which to read the data.

BaseDecoderImpl

public BaseDecoderImpl(org.refcodes.io.BytesReceiver aByteReceiver)
                throws IOException

Constructs the BaseDecoder reading the data to be decoded from the provided BytesReceiver.

Parameters:

aByteReceiver - The BytesReceiver from which to read the data.

Throws:

IOException - in case opening or accessing an open line (connection, junction, link) caused problems.

BaseDecoderImpl

protected BaseDecoderImpl()

Explicit default constructor.

Method Detail

getBaseMetrics

public BaseMetrics getBaseMetrics()

Retrieves the base codec metrics from the base codec metrics property.

Specified by:

getBaseMetrics in interface BaseMetricsAccessor

Returns:

The base codec metrics stored by the base codec metrics property.

setBaseMetrics

public void setBaseMetrics(BaseMetrics aBaseMetrics)

Sets the base codec metrics for the base codec metrics property.

Specified by:

setBaseMetrics in interface BaseMetricsAccessor.BaseMetricsMutator

Parameters:

aBaseMetrics - The base codec metrics to be stored by the font style property.

withBaseMetrics

public BaseDecoder withBaseMetrics(BaseMetrics aBaseMetrics)

Sets the base codec metrics for the base codec metrics property.

Specified by:

withBaseMetrics in interface BaseMetricsAccessor.BaseMetricsBuilder<BaseDecoder>

Parameters:

aBaseMetrics - The base codec metrics to be stored by the font style property.

Returns:

The builder for applying multiple build operations.

available

public int available()
              throws IOException

Specified by:

available in interface org.refcodes.io.Availability

Specified by:

available in interface org.refcodes.io.Skippable

Throws:

IOException

receiveAllBytes

public byte[] receiveAllBytes()
                       throws IOException

Specified by:

receiveAllBytes in interface org.refcodes.io.BytesDestination

Specified by:

receiveAllBytes in interface org.refcodes.io.BytesReceiver

Throws:

IOException

receiveByte

public byte receiveByte()
                 throws IOException

Specified by:

receiveByte in interface org.refcodes.io.ByteDestination

Specified by:

receiveByte in interface org.refcodes.io.BytesDestination

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface org.refcodes.component.Closable

Overrides:

close in class org.refcodes.component.AbstractConnectableAutomaton

Throws:

IOException

open

protected void open(org.refcodes.io.BytesDestination aConnection)
             throws IOException

Open.

Parameters:

aConnection - the connection

Throws:

IOException - the open exception