Package org.refcodes.io

Class ReceiverDecorator<DATA extends Serializable>

java.lang.Object

org.refcodes.component.AbstractConnectableAutomaton

org.refcodes.io.AbstractReceiver<DATA>

org.refcodes.io.ReceiverDecorator<DATA>

Type Parameters:

DATA - the generic type

All Implemented Interfaces:

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, BlockProvider<DATA>, BlockReceiver<DATA>, DatagramProvider<DATA>, DatagramReceiver<DATA>, Provider<DATA>, Receivable, Receiver<DATA>, org.refcodes.mixin.Releaseable

public class ReceiverDecorator<DATA extends Serializable>
extends AbstractReceiver<DATA>
implements Receiver<DATA>

The ReceiverDecorator decorates a Provider with the additional methods of a Receiver making it easy to use a Provider wherever a Receiver is expected. This is a very plain implementation: hasDatagram() always returns true if AbstractConnectableAutomaton.isOpened() is true and as long as none of the readDatagram(), readDatagrams() or readDatagrams(int) methods threw an OpenException ( InterruptedException). This implementation actually behaves as if close() has been called after verifying hasDatagram() and before any of the read methods have been called.

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

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

Field Summary

Fields inherited from class org.refcodes.io.AbstractReceiver

DATAGRAM_QUEUE_SIZE

Constructor Summary

Constructors

Constructor	Description
ReceiverDecorator(Provider<DATA> aProvider)	Instantiates a new receiver decorator.

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	hasDatagram()	Determines whether a datagram is available from a DatagramSender.
DATA	readDatagram()	Reads (receives) the next datagram passed from a DatagramSender counterpart.
DATA[]	readDatagrams()	Read datagrams.
DATA[]	readDatagrams(int aBlockSize)	Read datagrams.

Methods inherited from class org.refcodes.component.AbstractConnectableAutomaton

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

Methods inherited from class org.refcodes.io.AbstractReceiver

pushDatagram, pushDatagrams, pushDatagrams, releaseAll

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 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.mixin.Releaseable

releaseAll

Constructor Detail

ReceiverDecorator

public ReceiverDecorator(Provider<DATA> aProvider)

Instantiates a new receiver decorator.

Parameters:

aProvider - the provider

Method Detail

readDatagram

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

Reads (receives) the next datagram passed from a DatagramSender counterpart. In case none datagram is available, then this method blocks until one is available. To prevent blocking, use the DatagramReceiver extension's Receivable.hasDatagram() method to test beforehand whether a byte is available (in a multi-threaded usage scenario, Receivable.hasDatagram() is not a reliable indicator whether this method will block or not). When a Thread is waiting for a datagram to be read and Thread.interrupt() is being called, then the operation is aborted and an InterruptedException is thrown.

Specified by:

readDatagram in interface DatagramProvider<DATA extends Serializable>

Overrides:

readDatagram in class AbstractReceiver<DATA extends Serializable>

Returns:

The next datagram sent from the DatagramSender counterpart.

Throws:

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

InterruptedException - Thrown when a Thread is waiting, sleeping, or otherwise occupied, and the Thread is interrupted, either before or during the activity.

hasDatagram

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

Determines whether a datagram is available from a DatagramSender. Use the DatagramProvider extenison's DatagramProvider.readDatagram() method for retrieving the available datagram.

Specified by:

hasDatagram in interface Receivable

Overrides:

hasDatagram in class AbstractReceiver<DATA extends Serializable>

Returns:

True in case there is a datagram ready to be retrieved .

Throws:

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

readDatagrams

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

Read datagrams.

Specified by:

readDatagrams in interface BlockProvider<DATA extends Serializable>

Specified by:

readDatagrams in interface Provider<DATA extends Serializable>

Specified by:

readDatagrams in interface Receiver<DATA extends Serializable>

Overrides:

readDatagrams in class AbstractReceiver<DATA extends Serializable>

Returns:

the DAT a[]

Throws:

org.refcodes.component.OpenException - the open exception

InterruptedException - the interrupted exception

readDatagrams

public DATA[] readDatagrams(int aBlockSize)
                     throws org.refcodes.component.OpenException,
                            InterruptedException

Read datagrams.

Specified by:

readDatagrams in interface BlockProvider<DATA extends Serializable>

Specified by:

readDatagrams in interface Provider<DATA extends Serializable>

Specified by:

readDatagrams in interface Receiver<DATA extends Serializable>

Parameters:

aBlockSize - the block size

Returns:

the DAT a[]

Throws:

org.refcodes.component.OpenException - the open exception

InterruptedException - the interrupted exception

close

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

Specified by:

close in interface org.refcodes.component.Closable

Overrides:

close in class AbstractReceiver<DATA extends Serializable>

Throws:

org.refcodes.component.CloseException