Package org.refcodes.io

Class OutputStreamByteSenderImpl

java.lang.Object

org.refcodes.io.OutputStreamByteSenderImpl

All Implemented Interfaces:

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, ByteBlockConsumer, ByteBlockSender, ByteConsumer, ByteDatagramConsumer, ByteDatagramSender, ByteSender, Sendable

public class OutputStreamByteSenderImpl
extends Object
implements ByteSender

The Class OutputStreamByteSenderImpl.

Author:

steiner

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
OutputStreamByteSenderImpl(OutputStream aOutputStream)	Instantiates a new output stream byte sender impl.

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()
org.refcodes.component.ConnectionStatus	getConnectionStatus()
boolean	isClosable()
boolean	isClosed()
boolean	isOpened()
void	writeDatagram(byte aDatagram)	Writes (sends) a byte.
void	writeDatagrams(byte[] aDatagram)	Writes (sends) a byte block.
void	writeDatagrams(byte[] aDatagram, int aOffset, int aLength)	Writes (sends) a byte block.

Methods inherited from interface org.refcodes.component.Closable

closeIn, closeQuietly, closeUnchecked

Methods inherited from interface org.refcodes.component.ConnectionStatusAccessor

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

Constructor Detail

OutputStreamByteSenderImpl

public OutputStreamByteSenderImpl(OutputStream aOutputStream)
                           throws org.refcodes.component.OpenException

Instantiates a new output stream byte sender impl.

Parameters:

aOutputStream - the output stream

Throws:

org.refcodes.component.OpenException - the open exception

Method Detail

writeDatagrams

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

Writes (sends) a byte block.

Specified by:

writeDatagrams in interface ByteBlockConsumer

Specified by:

writeDatagrams in interface ByteConsumer

Parameters:

aDatagram - The byte to be pushed.

Throws:

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

isClosed

public boolean isClosed()

Specified by:

isClosed in interface org.refcodes.component.ClosedAccessor

isOpened

public boolean isOpened()

Specified by:

isOpened in interface org.refcodes.component.OpenedAccessor

getConnectionStatus

public org.refcodes.component.ConnectionStatus getConnectionStatus()

Specified by:

getConnectionStatus in interface org.refcodes.component.ConnectionStatusAccessor

writeDatagrams

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

Writes (sends) a byte block.

Specified by:

writeDatagrams in interface ByteBlockConsumer

Specified by:

writeDatagrams in interface ByteSender

Parameters:

aDatagram - The byte 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.

close

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

Specified by:

close in interface org.refcodes.component.Closable

Throws:

org.refcodes.component.CloseException

writeDatagram

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

Writes (sends) a byte.

Specified by:

writeDatagram in interface ByteConsumer

Specified by:

writeDatagram in interface ByteDatagramConsumer

Parameters:

aDatagram - The byte to be pushed.

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 ByteSender

Specified by:

flush in interface Flushable

Specified by:

flush in interface org.refcodes.component.Flushable

Throws:

org.refcodes.component.OpenException

isClosable

public boolean isClosable()

Specified by:

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