Package org.refcodes.io
Class SenderDecorator<DATA extends java.io.Serializable>
- java.lang.Object
-
- org.refcodes.component.AbstractConnectableAutomaton
-
- org.refcodes.io.AbstractSender<DATA>
-
- org.refcodes.io.SenderDecorator<DATA>
-
- Type Parameters:
DATA
- the generic type
- 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
,BlockConsumer<DATA>
,BlockSender<DATA>
,Consumer<DATA>
,DatagramConsumer<DATA>
,DatagramSender<DATA>
,Sendable
,Sender<DATA>
public class SenderDecorator<DATA extends java.io.Serializable> extends AbstractSender<DATA> implements Sender<DATA>
TheSenderDecorator
decorates aConsumer
with the additional methods of aSender
making it easy to use aConsumer
wherever aSender
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
-
-
Constructor Summary
Constructors Constructor Description SenderDecorator(Consumer<DATA> aConsumer)
Instantiates a new sender decorator.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
void
flush()
void
writeDatagram(DATA aDatagram)
Writes (sends) a datagram to a listeningDatagramReceiver
.void
writeDatagrams(DATA[] aDatagrams)
Writes (sends) a datagram block to a listeningDatagramReceiver
orBlockReceiver
.void
writeDatagrams(DATA[] aDatagrams, int aOffset, int aLength)
Write datagrams.-
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.ConnectionStatusAccessor
getConnectionStatus, isConnectionOpened
-
-
-
-
Method Detail
-
writeDatagram
public void writeDatagram(DATA aDatagram) throws org.refcodes.component.OpenException
Writes (sends) a datagram to a listeningDatagramReceiver
.- Specified by:
writeDatagram
in interfaceConsumer<DATA extends java.io.Serializable>
- Specified by:
writeDatagram
in interfaceDatagramConsumer<DATA extends java.io.Serializable>
- Parameters:
aDatagram
- The datagram to be pushed to the receivingDatagramConsumer
.- Throws:
org.refcodes.component.OpenException
- Thrown in case opening or accessing an open line (connection, junction, link) caused problems.
-
writeDatagrams
public void writeDatagrams(DATA[] aDatagrams) throws org.refcodes.component.OpenException
Writes (sends) a datagram block to a listeningDatagramReceiver
orBlockReceiver
.- Specified by:
writeDatagrams
in interfaceBlockConsumer<DATA extends java.io.Serializable>
- Specified by:
writeDatagrams
in interfaceConsumer<DATA extends java.io.Serializable>
- Parameters:
aDatagrams
- The datagram to be pushed to the receivingDatagramReceiver
orBlockReceiver
.- Throws:
org.refcodes.component.OpenException
- Thrown in case opening or accessing an open line (connection, junction, link) caused problems.
-
writeDatagrams
public void writeDatagrams(DATA[] aDatagrams, int aOffset, int aLength) throws org.refcodes.component.OpenException
Write datagrams.- Specified by:
writeDatagrams
in interfaceBlockConsumer<DATA extends java.io.Serializable>
- Specified by:
writeDatagrams
in interfaceSender<DATA extends java.io.Serializable>
- Parameters:
aDatagrams
- the datagramaOffset
- the offsetaLength
- the length- Throws:
org.refcodes.component.OpenException
- the open exception
-
flush
public void flush() throws org.refcodes.component.OpenException
-
close
public void close() throws org.refcodes.component.CloseException
- Specified by:
close
in interfaceorg.refcodes.component.Closable
- Overrides:
close
in classorg.refcodes.component.AbstractConnectableAutomaton
- Throws:
org.refcodes.component.CloseException
-
-