org.refcodes.codec.impls

Class BaseDecodeReceiverImpl

java.lang.Object

org.refcodes.codec.impls.BaseDecodeReceiverImpl

All Implemented Interfaces:

BaseCodecMetricsAccessor, BaseCodecMetricsAccessor.BaseCodecMetricsBuilder<BaseDecodeReceiver>, BaseCodecMetricsAccessor.BaseCodecMetricsMutator, BaseCodecMetricsAccessor.BaseCodecMetricsProperty, BaseDecodeReceiver, DecodeReceiver, 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.ByteBlockReceiver, org.refcodes.io.ByteDatagramReceiver, org.refcodes.io.ByteReceiver, org.refcodes.io.Receivable, org.refcodes.mixin.Releaseable

Direct Known Subclasses:

BaseDecodeInputStreamReceiverImpl

public class BaseDecodeReceiverImpl
extends Object
implements BaseDecodeReceiver

Vanilla plain implementation of the BaseDecodeReceiver interface to be used with ByteReceiver instances.

Nested Class Summary

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

BaseCodecMetricsAccessor.BaseCodecMetricsBuilder<B extends BaseCodecMetricsAccessor.BaseCodecMetricsBuilder<B>>, BaseCodecMetricsAccessor.BaseCodecMetricsMutator, BaseCodecMetricsAccessor.BaseCodecMetricsProperty

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

org.refcodes.component.ConnectableComponent.ConnectableAutomaton

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.component.Closable

org.refcodes.component.Closable.CloseAutomaton

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

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

Constructor Summary

Constructors

Constructor and Description
BaseDecodeReceiverImpl(org.refcodes.io.ByteReceiver aByteReceiver)

Method Summary

Modifier and Type	Method and Description
void	close()
BaseCodecMetrics	getBaseCodecMetrics() Retrieves the base codec metrics from the base codec metrics property.
org.refcodes.component.ConnectionStatus	getConnectionStatus()
boolean	hasDatagram()
boolean	isClosable()
boolean	isClosed()
boolean	isOpened()
byte	readDatagram()
byte[]	readDatagrams()
void	releaseAll()
void	setBaseCodecMetrics(BaseCodecMetrics aBaseCodecMetrics) Sets the base codec metrics for the base codec metrics property.
BaseDecodeReceiver	withBaseCodecMetrics(BaseCodecMetrics aBaseCodecMetrics) Sets the base codec metrics for the base codec metrics property.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.component.Closable

closeIn, closeQuietly

Constructor Detail

BaseDecodeReceiverImpl

public BaseDecodeReceiverImpl(org.refcodes.io.ByteReceiver aByteReceiver)

Method Detail

getBaseCodecMetrics

public BaseCodecMetrics getBaseCodecMetrics()

Description copied from interface: BaseCodecMetricsAccessor

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

Specified by:

getBaseCodecMetrics in interface BaseCodecMetricsAccessor

Returns:

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

setBaseCodecMetrics

public void setBaseCodecMetrics(BaseCodecMetrics aBaseCodecMetrics)

Description copied from interface: BaseCodecMetricsAccessor.BaseCodecMetricsMutator

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

Specified by:

setBaseCodecMetrics in interface BaseCodecMetricsAccessor.BaseCodecMetricsMutator

Parameters:

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

withBaseCodecMetrics

public BaseDecodeReceiver withBaseCodecMetrics(BaseCodecMetrics aBaseCodecMetrics)

Description copied from interface: BaseCodecMetricsAccessor.BaseCodecMetricsBuilder

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

Specified by:

withBaseCodecMetrics in interface BaseCodecMetricsAccessor.BaseCodecMetricsBuilder<BaseDecodeReceiver>

Parameters:

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

Returns:

The builder for applying multiple build operations.

hasDatagram

public boolean hasDatagram()
                    throws org.refcodes.component.OpenException

Specified by:

hasDatagram in interface org.refcodes.io.Receivable

Throws:

org.refcodes.component.OpenException

readDatagrams

public byte[] readDatagrams()
                     throws org.refcodes.component.OpenException,
                            InterruptedException

Specified by:

readDatagrams in interface org.refcodes.io.ByteBlockReceiver

Specified by:

readDatagrams in interface org.refcodes.io.ByteReceiver

Throws:

org.refcodes.component.OpenException

InterruptedException

readDatagram

public byte readDatagram()
                  throws org.refcodes.component.OpenException,
                         InterruptedException

Specified by:

readDatagram in interface org.refcodes.io.ByteDatagramReceiver

Throws:

org.refcodes.component.OpenException

InterruptedException

releaseAll

public void releaseAll()

Specified by:

releaseAll in interface org.refcodes.mixin.Releaseable

isOpened

public boolean isOpened()

Specified by:

isOpened in interface org.refcodes.component.OpenedAccessor

isClosable

public boolean isClosable()

Specified by:

isClosable in interface org.refcodes.component.Closable.CloseAutomaton

close

public void close()
           throws org.refcodes.component.CloseException

Specified by:

close in interface org.refcodes.component.Closable

Throws:

org.refcodes.component.CloseException

isClosed

public boolean isClosed()

Specified by:

isClosed in interface org.refcodes.component.ClosedAccessor

getConnectionStatus

public org.refcodes.component.ConnectionStatus getConnectionStatus()

Specified by:

getConnectionStatus in interface org.refcodes.component.ConnectionStatusAccessor