Class AbstractInputStreamByteReceiver

java.lang.Object

org.refcodes.component.AbstractConnectable

org.refcodes.component.AbstractConnectableAutomaton

org.refcodes.io.AbstractInputStreamByteReceiver

All Implemented Interfaces:

Closable, Closable.CloseAutomaton, ClosedAccessor, ConnectableComponent, ConnectableComponent.ConnectableAutomaton, ConnectionStatusAccessor, OpenedAccessor, Availability, ByteDestination, ByteReceiver, BytesDestination, BytesReceiver, Receivable, Skippable, TimeoutInputStreamAccessor, InputStreamAccessor

Direct Known Subclasses:

BidirectionalStreamConnectionByteTransceiverImpl, InputStreamConnectionByteReceiverImpl

public abstract class AbstractInputStreamByteReceiver
extends AbstractConnectableAutomaton
implements BytesReceiver

Abstract implementation of the BytesReceiver interface. The open(InputStream), AbstractConnectableAutomaton.setConnectionStatus(ConnectionStatus) and AbstractConnectableAutomaton.isOpenable() methods are your hooks when extending this class.

Nested Class Summary

Nested classes/interfaces inherited from interface BytesReceiver

BytesReceiver.ReceiverInputStream

Nested classes/interfaces inherited from interface Closable

Closable.CloseAutomaton, Closable.CloseBuilder<B>

Nested classes/interfaces inherited from interface ClosedAccessor

ClosedAccessor.ClosedMutator, ClosedAccessor.ClosedProperty

Nested classes/interfaces inherited from interface ConnectableComponent

ConnectableComponent.ConnectableAutomaton

Nested classes/interfaces inherited from interface ConnectionStatusAccessor

ConnectionStatusAccessor.ConnectionStatusMutator, ConnectionStatusAccessor.ConnectionStatusProperty

Nested classes/interfaces inherited from interface InputStreamAccessor

InputStreamAccessor.InputStreamBuilder<B>, InputStreamAccessor.InputStreamMutator, InputStreamAccessor.InputStreamProperty

Nested classes/interfaces inherited from interface OpenedAccessor

OpenedAccessor.OpenedMutator, OpenedAccessor.OpenedProperty

Nested classes/interfaces inherited from interface TimeoutInputStreamAccessor

TimeoutInputStreamAccessor.TimeoutInputStreamBuilder<B>, TimeoutInputStreamAccessor.TimeoutInputStreamMutator, TimeoutInputStreamAccessor.TimeoutInputStreamProperty

Constructor Summary

Constructors

Constructor	Description
AbstractInputStreamByteReceiver()

Method Summary

Modifier and Type	Method	Description
int	available()	Determines the number of available datagram from a DatagramTransmitter.
void	close()
protected boolean	isOpenable(InputStream aInputStream)	Checks if is openable.
protected void	open(InputStream aInputStream)	Open, see ConnectionOpenable.open(Object).
byte	receiveByte()	Reads (receives) the next byte, in case none byte is available, then this method blocks until one is available.

Methods inherited from class AbstractConnectableAutomaton

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

Methods inherited from class AbstractConnectable

isThrownAsOfAlreadyClosed

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Availability

hasAvailable

Methods inherited from interface BytesDestination

receiveBytes

Methods inherited from interface BytesReceiver

getInputStream, getInputStream, receiveAllBytes, receiveBytes, receiveBytesWithin, receiveBytesWithin, receiveByteWithin, skip

Methods inherited from interface Closable

closeIn, closeQuietly, closeUnchecked

Methods inherited from interface Closable.CloseAutomaton

isClosable

Methods inherited from interface ClosedAccessor

isClosed

Methods inherited from interface ConnectionStatusAccessor

getConnectionStatus, isOpened

Methods inherited from interface Skippable

skipAvailable, skipAvailableExcept, skipAvailableTill, skipAvailableTillSilenceFor, skipAvailableTillSilenceFor, skipAvailableWithin, skipAvailableWithin, skipAvailableWithin

Constructor Details

AbstractInputStreamByteReceiver

public AbstractInputStreamByteReceiver()

Method Details

available

public int available()
              throws IOException

Determines the number of available datagram from a DatagramTransmitter. Use the DatagramDestination extenison's DatagramDestination.receive() method for retrieving available datagrams.

Specified by:

available in interface Availability

Specified by:

available in interface Skippable

Returns:

The number of datagrams ready to be retrieved .

Throws:

IOException - Thrown in case opening or accessing an open line (connection, junction, link) caused problems.

receiveByte

public byte receiveByte()
                 throws IOException

Reads (receives) the next byte, in case none byte is available, then this method blocks until one is available.

Specified by:

receiveByte in interface ByteDestination

Specified by:

receiveByte in interface BytesDestination

Returns:

The next byte available .

Throws:

IOException - Thrown in case opening or accessing an open line (connection, junction, link) caused problems.

close

public void close()
           throws IOException

Specified by:

close in interface Closable

Overrides:

close in class AbstractConnectableAutomaton

Throws:

IOException

open

protected void open(InputStream aInputStream)
             throws IOException

Open, see ConnectionOpenable.open(Object).

Parameters:

aInputStream - the input stream

Throws:

IOException - the open exception

isOpenable

protected boolean isOpenable(InputStream aInputStream)

Checks if is openable. See also ConnectionOpenable.ConnectionOpenAutomaton.isOpenable(Object).

Parameters:

aInputStream - the input stream

Returns:

true, if is openable