Package org.refcodes.io

Class ShortSenderDecorator

java.lang.Object

org.refcodes.component.AbstractConnectableAutomaton

org.refcodes.io.AbstractShortSender

org.refcodes.io.ShortSenderDecorator

All Implemented Interfaces:

java.io.Flushable, 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.Flushable, org.refcodes.component.OpenedAccessor, Sendable, ShortBlockConsumer, ShortBlockSender, ShortConsumer, ShortDatagramConsumer, ShortDatagramSender, ShortSender

public class ShortSenderDecorator
extends AbstractShortSender
implements ShortSender

The ShortSenderDecorator decorates a ShortConsumer with the additional methods of a ShortSender making it easy to use a ShortConsumer wherever a ShortSender is expected.

Nested Class Summary

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

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

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

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

Constructor Summary

Constructors

Constructor	Description
ShortSenderDecorator(ShortConsumer aShortConsumer)	Instantiates a new short sender decorator.

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()
void	writeDatagram(short aDatagram)	Writes (sends) a short.
void	writeDatagrams(short[] aDatagrams)	Writes (sends) a short block.
void	writeDatagrams(short[] aDatagrams, int aOffset, int aLength)	Writes (sends) a short block.

Methods inherited from class org.refcodes.component.AbstractConnectableAutomaton

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

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, isConnectionOpened

Methods inherited from interface org.refcodes.component.Flushable

flushUnchecked, isFlushable

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

Constructor Detail

ShortSenderDecorator

public ShortSenderDecorator(ShortConsumer aShortConsumer)

Instantiates a new short sender decorator.

Parameters:

aShortConsumer - the short consumer

Method Detail

writeDatagram

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

Writes (sends) a short.

Specified by:

writeDatagram in interface ShortConsumer

Specified by:

writeDatagram in interface ShortDatagramConsumer

Parameters:

aDatagram - The short to be pushed.

Throws:

org.refcodes.component.OpenException - Thrown in case opening or accessing an open line (connection, junction, link) caused problems.

writeDatagrams

public void writeDatagrams(short[] aDatagrams)
                    throws org.refcodes.component.OpenException

Writes (sends) a short block.

Specified by:

writeDatagrams in interface ShortBlockConsumer

Specified by:

writeDatagrams in interface ShortConsumer

Parameters:

aDatagrams - The short to be pushed.

Throws:

org.refcodes.component.OpenException - Thrown in case opening or accessing an open line (connection, junction, link) caused problems.

writeDatagrams

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

Writes (sends) a short block.

Specified by:

writeDatagrams in interface ShortBlockConsumer

Specified by:

writeDatagrams in interface ShortSender

Parameters:

aDatagrams - The short to be pushed.

aOffset - The offset from which to take the data.

aLength - The number of elements to push starting at the given offset.

Throws:

org.refcodes.component.OpenException - Thrown in case opening or accessing an open line (connection, junction, link) caused problems.

flush

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

Specified by:

flush in interface java.io.Flushable

Specified by:

flush in interface org.refcodes.component.Flushable

Specified by:

flush in interface ShortSender

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