org.refcodes.codec

Class AbstractBaseEncoder

java.lang.Object

org.refcodes.component.AbstractConnectableAutomaton

org.refcodes.codec.AbstractBaseEncoder

All Implemented Interfaces:

Flushable, BaseEncoder, BaseMetricsAccessor, BaseMetricsAccessor.BaseCodecMetricsProperty, BaseMetricsAccessor.BaseMetricsBuilder<BaseEncoder>, BaseMetricsAccessor.BaseMetricsMutator, Encoder, 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.ByteBlockConsumer, org.refcodes.io.ByteBlockSender, org.refcodes.io.ByteConsumer, org.refcodes.io.ByteDatagramConsumer, org.refcodes.io.ByteDatagramSender, org.refcodes.io.ByteSender, org.refcodes.io.Sendable

Direct Known Subclasses:

BaseEncoderImpl, BaseEncoderImpl.BaseEncoderConsumerImpl

public abstract class AbstractBaseEncoder
extends org.refcodes.component.AbstractConnectableAutomaton
implements BaseEncoder

Vanilla plain implementation of the BaseEncoder interface to be used with ByteSender instances.

Nested Class Summary

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

BaseEncoder.BaseEncoderConsumer

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

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

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

org.refcodes.component.Flushable.FlushBuilder<B extends org.refcodes.component.Flushable.FlushBuilder<B>>

Constructor Summary

Constructors

Constructor and Description
AbstractBaseEncoder()

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
BaseMetrics	getBaseMetrics() Retrieves the base codec metrics from the base codec metrics property.
protected void	open(org.refcodes.io.ByteConsumer aConnection) Open.
void	setBaseMetrics(BaseMetrics aBaseMetrics) Sets the base codec metrics for the base codec metrics property.
BaseEncoder	withBaseMetrics(BaseMetrics _baseCodecMetrics) Sets the base codec metrics for the base codec metrics property.
void	writeDatagram(byte aDatagram)
void	writeDatagrams(byte[] aDatagram)
void	writeDatagrams(byte[] aDatagram, int aOffset, int aLength)

Methods inherited from class org.refcodes.component.AbstractConnectableAutomaton

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

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

isOpened

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

isClosable

Methods inherited from interface org.refcodes.component.Closable

closeIn, closeQuietly, closeUnchecked

Methods inherited from interface org.refcodes.component.ClosedAccessor

isClosed

Methods inherited from interface org.refcodes.component.ConnectionStatusAccessor

getConnectionStatus

Methods inherited from interface org.refcodes.component.Flushable

flushUnchecked

Constructor Detail

AbstractBaseEncoder

public AbstractBaseEncoder()

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 BaseEncoder withBaseMetrics(BaseMetrics _baseCodecMetrics)

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

Specified by:

withBaseMetrics in interface BaseMetricsAccessor.BaseMetricsBuilder<BaseEncoder>

Parameters:

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

Returns:

The builder for applying multiple build operations.

writeDatagram

public void writeDatagram(byte aDatagram)
                   throws org.refcodes.component.OpenException

Specified by:

writeDatagram in interface org.refcodes.io.ByteConsumer

Specified by:

writeDatagram in interface org.refcodes.io.ByteDatagramConsumer

Throws:

org.refcodes.component.OpenException

writeDatagrams

public void writeDatagrams(byte[] aDatagram)
                    throws org.refcodes.component.OpenException

Specified by:

writeDatagrams in interface org.refcodes.io.ByteBlockConsumer

Specified by:

writeDatagrams in interface org.refcodes.io.ByteConsumer

Throws:

org.refcodes.component.OpenException

writeDatagrams

public void writeDatagrams(byte[] aDatagram,
                           int aOffset,
                           int aLength)
                    throws org.refcodes.component.OpenException

Specified by:

writeDatagrams in interface org.refcodes.io.ByteBlockConsumer

Specified by:

writeDatagrams in interface org.refcodes.io.ByteSender

Throws:

org.refcodes.component.OpenException

flush

public void flush()
           throws org.refcodes.component.OpenException

Specified by:

flush in interface Flushable

Specified by:

flush in interface org.refcodes.io.ByteSender

Throws:

org.refcodes.component.OpenException

close

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

Specified by:

close in interface org.refcodes.component.Closable

Overrides:

close in class org.refcodes.component.AbstractConnectableAutomaton

Throws:

org.refcodes.component.CloseException

open

protected void open(org.refcodes.io.ByteConsumer aConnection)
             throws org.refcodes.component.OpenException

Open.

Parameters:

aConnection - the a connection

Throws:

org.refcodes.component.OpenException - the open exception