Module org.refcodes.io

Package org.refcodes.io

package org.refcodes.io

This artifact defines basic types handling communication between processes (across system boundaries), to be harnessed by complex and low level I/O, such as the InputStream decorator types ReplayInputStream, FilterInputStream, ClipboardInputStream, ZipFileInputStream, ReplaceInputStream or TimeoutInputStream alongside AvailableInputStream as well as the OutputStream decorator types ClipboardOutputStream, LineBreakOutputStream or ZipFileOutputStream.

Please refer to the refcodes-io: Paving the road for complex and low level I/O across boundaries documentation for an up-to-date and detailed description on the usage of this artifact.

Class	Description
AbstractBytesDestination	The AbstractBytesDestination is a base abstract implementation of the BytesDestination interface providing common functionality for concrete real implementations.
AbstractBytesReceiver	The AbstractBytesReceiver is a base abstract implementation of the BytesReceiver interface providing common functionality for concrete real live implementations.
AbstractBytesReceiver.ConnectableAutomaton	The Class ConnectableAutomaton.
AbstractBytesTransmitter	The AbstractBytesTransmitter is a base abstract implementation of the BytesTransmitter interface providing common functionality for concrete real live implementations.
AbstractDatagramsReceiver<DATA extends Serializable>	The AbstractDatagramsReceiver is a base abstract implementation of the DatagramsReceiver interface providing common functionality for concrete real live implementations.
AbstractDatagramsTransmitter<DATA extends Serializable>	The AbstractDatagramsTransmitter is a base abstract implementation of the BytesTransmitter interface providing common functionality for concrete real live implementations.
AbstractInputStreamByteReceiver	Abstract implementation of the BytesReceiver interface.
AbstractInputStreamReceiver<DATA extends Serializable>	Abstract implementation of the DatagramsReceiver interface.
AbstractPrefetchInputStreamByteReceiver	Abstract implementation of the BytesReceiver interface.
AbstractPrefetchInputStreamReceiver<DATA extends Serializable>	Abstract implementation of the DatagramsReceiver interface.
AbstractShortsDestination	The AbstractShortsDestination is a base abstract implementation of the ShortsDestination interface providing common functionality for concrete real live implementations.
AbstractShortsReceiver	The AbstractShortsReceiver is a base abstract implementation of the ShortsReceiver interface providing common functionality for concrete real live implementations.
AbstractShortsReceiver.ConnectableAutomaton	The Class ConnectableAutomaton.
AbstractShortsTransmitter	The AbstractShortsTransmitter is a base abstract implementation of the ShortsTransmitter interface providing common functionality for concrete real live ShortsTransmitter and ShortsTransmitter (= ShortsTransmitter) implementations.
Availability	The Availability interface defines methods to test availability of data.
AvailableInputStream	The AvailableInputStream decorates an InputStream with time-out functionality using the InputStream.available() method.
BidirectionalConnectionByteTransceiver<INPUT,OUTPUT>	The BidirectionalConnectionByteTransceiver defines the DatagramTransceiver functionality set on top of a I/O connection (as of the BidirectionalConnectionComponent.BidirectionalConnectionAutomaton).
BidirectionalConnectionTransceiver<DATA extends Serializable,INPUT,OUTPUT>	The BidirectionalConnectionTransceiver defines the DatagramTransceiver functionality set on top of a I/O connection (as of the BidirectionalConnectionComponent.BidirectionalConnectionAutomaton).
BidirectionalStreamByteTransceiver	The Class BidirectionalStreamByteTransceiver.
BidirectionalStreamConnectionByteTransceiver	A BidirectionalStreamConnectionByteTransceiver is a DatagramTransceiver connected through I/O streams with another BidirectionalStreamConnectionByteTransceiver.
BidirectionalStreamConnectionByteTransceiverImpl	The Class BidirectionalStreamConnectionByteTransceiverImpl.
BidirectionalStreamConnectionTransceiver<DATA extends Serializable>	A BidirectionalStreamConnectionTransceiver is a DatagramTransceiver connected through I/O streams with another BidirectionalStreamConnectionTransceiver.
BidirectionalStreamConnectionTransceiverImpl<DATA extends Serializable>	The Class BidirectionalStreamConnectionTransceiverImpl.
BidirectionalStreamTransceiver<DATA extends Serializable>	The Class BidirectionalStreamTransceiver.
BijectiveOutputStream	A BijectiveOutputStream wraps an OutputStream and produces output bytes by applying a BijectiveFunction on each byte to be written before delegating the processed vale to the given OutputStream.
BlockingInputStream	The BlockingInputStream wraps an InputStream adding blocking functionality, e.g. when trying to read, the read operation is blocked till BlockingInputStream.available() returns a value greater than 0.
BoundedInputStream	A BoundedInputStream decorates an InputStream and restricts reading bytes from the InputStream decoratee up to a given total number of bytes (bounds).
ByteArrayReceiver	The Class ByteArrayReceiver.
ByteArraySource	The Class ByteArraySource.
ByteDestination	The ByteDestination is used to receive bytes in a unified way.
ByteReceiver	The ByteReceiver is used to receive bytes in a unified way.
BytesDestination	The BytesDestination is used to receive byte blocks (arrays) in a unified way.
BytesInputStream	(as InputStream does not provide some useful *interface*)
ByteSource	The ByteSource is used to send bytes in a unified way.
BytesOutputStream	(as OutputStream does not provide some useful *interface*)
BytesReceiver	The Interface BytesReceiver.
BytesReceiver.ReceiverInputStream	The BytesReceiver.ReceiverInputStream constructs an InputStream from a BytesReceiver.
BytesReceiverDecorator	The BytesReceiverDecorator decorates a BytesDestination with the additional methods of a BytesReceiver making it easy to use a BytesDestination wherever a BytesReceiver is expected.
BytesSource	The BytesSource is used to send byte blocks (arrays) in a unified way.
BytesTransceiver	A BytesTransceiver combines the functionality of a BytesTransmitter and of a BytesReceiver. e.g. for building loopback devices.
BytesTransmitter	The Interface BytesTransmitter.
BytesTransmitter.TransmitterOutputStream	The BytesTransmitter.TransmitterOutputStream constructs an OutputStream from a BytesTransmitter.
ByteTransceiver	Combines the ByteTransmitter and ByteReceiver functionality in a single interface to be implemented by a single class so that ByteTransmitter and ByteReceiver functionality can be provided by a single instance.
ByteTransmitter	The ByteTransmitter is used to transmit bytes in a unified way.
ByteTransmitterDecorator	The ByteTransmitterDecorator decorates a BytesSource with the additional methods of a BytesTransmitter making it easy to use a BytesSource wherever a BytesTransmitter is expected.
ClipboardInputStream	A ClipboardInputStream provides the clipboard as InputStream.
ClipboardOutputStream	A ClipboardOutputStream writes into the clipboard after ClipboardOutputStream.flush() as well as ClipboardOutputStream.close() being called.
ConnectionBytesReceiver<CON>	The ConnectionBytesReceiver defines the DatagramReceiver functionality set on top of a connection (as of the ConnectionComponent.ConnectionAutomaton) for data types "byte".
ConnectionBytesTransceiver<CON>	The ConnectionBytesTransceiver defines the DatagramTransceiver functionality set on top of a connection (as of the ConnectionComponent.ConnectionAutomaton) for data types "byte".
ConnectionBytesTransmitter<CON>	The ConnectionBytesTransmitter defines the DatagramTransmitter functionality set on top of a connection (as of the ConnectionComponent.ConnectionAutomaton) for data types "byte".
ConnectionDatagramsReceiver<DATA extends Serializable,CON>	The ConnectionDatagramsReceiver defines the DatagramReceiver functionality set on top of a connection (as of the ConnectionComponent.ConnectionAutomaton).
ConnectionDatagramsTransceiver<DATA extends Serializable,CON>	The ConnectionDatagramsTransceiver defines the DatagramTransceiver functionality set on top of a connection (as of the ConnectionComponent.ConnectionAutomaton).
ConnectionDatagramsTransmitter<DATA extends Serializable,CON>	The ConnectionDatagramsTransmitter defines the DatagramTransmitter functionality set on top of a connection (as of the ConnectionComponent.ConnectionAutomaton).
ConnectionShortsReceiver<CON>	The ConnectionShortsReceiver defines the DatagramReceiver functionality set on top of a connection (as of the ConnectionComponent.ConnectionAutomaton) for data types "short".
ConnectionShortsTransceiver<CON>	The ConnectionShortsTransceiver defines the DatagramTransceiver functionality set on top of a connection (as of the ConnectionComponent.ConnectionAutomaton) for data types "short".
ConnectionShortsTransmitter<CON>	The ConnectionShortsTransmitter defines the DatagramTransmitter functionality set on top of a connection (as of the ConnectionComponent.ConnectionAutomaton) for data types "short".
DatagramDestination<DATA extends Serializable>	The DatagramDestination is used to receive datagrams in a unified way.
DatagramReceiver<DATA extends Serializable>	The DatagramReceiver is used to receive datagrams in a unified way.
DatagramsDestination<DATA extends Serializable>	The DatagramsDestination is used to receive data blocks (arrays) in a unified way.
DatagramSource<DATA extends Serializable>	The DatagramSource is used to send datagrams in a unified way.
DatagramsReceiver<DATA extends Serializable>	The Interface DatagramsReceiver.
DatagramsReceiverDecorator<DATA extends Serializable>	The DatagramsReceiverDecorator decorates a DatagramsDestination with the additional methods of a DatagramsReceiver making it easy to use a DatagramsDestination wherever a DatagramsReceiver is expected.
DatagramsSource<DATA extends Serializable>	The DatagramsSource is used to send datagram blocks (arrays) in a unified way.
DatagramsTransceiver<DATA extends Serializable>	A DatagramsTransceiver combines the functionality of a DatagramsTransmitter and of a DatagramsReceiver. e.g. for building loopback devices.
DatagramsTransmitter<DATA extends Serializable>	The DatagramsTransmitter is used to send datagram blocks (arrays) in a unified way.
DatagramTransceiver<DATA extends Serializable>	Combines the DatagramTransmitter and DatagramReceiver functionality in a single interface to be implemented by a single class so that DatagramTransmitter and DatagramReceiver functionality can be provided by a single instance.
DatagramTransmitter<DATA extends Serializable>	The DatagramTransmitter is used to send datagrams in a unified way.
FileUtility	The FileUtility provides Various file related utility functionality.
FilterInputStream	The FilterInputStream wraps an InputStream adding filtering functionality of bytes to be skipped.
InputStreamByteReceiver	The Class InputStreamByteReceiver.
InputStreamConnectionByteReceiver	A InputStreamConnectionByteReceiver is a DatagramReceiver connected through I/O streams with a OutputStreamConnectionDatagramsTransmitter.
InputStreamConnectionByteReceiverImpl	Implementation of the InputStreamConnectionReceiver interface.
InputStreamConnectionReceiver<DATA extends Serializable>	A InputStreamConnectionReceiver is a DatagramReceiver connected through I/O streams with a OutputStreamConnectionDatagramsTransmitter.
InputStreamConnectionReceiverImpl<DATA extends Serializable>	Implementation of the InputStreamConnectionReceiver interface.
InputStreamReceiver<DATA extends Serializable>	The Class InputStreamReceiver.
InputStreamStringBuilder	The InputStreamStringBuilder constructs String instances from InputStream instances.
InverseInputStream	A InverseInputStream wraps an InputStream and consumes input bytes by applying a InverseFunction on each byte read from the provided InputStream before passing back the processed byte to the caller.
IOResultAccessor<RES,EXC extends Exception>	Extends the ResultAccessor interface with an I/O timeout mechanism.
LineBreakOutputStream	A LineBreakOutputStream wraps an OutputStream for adding line breaks after a given number of bytes being written.
LoopbackBytesReceiver	A LoopbackBytesReceiver is a DatagramReceiver connected directly within the same JVM with a LoopbackBytesTransmitter; a "loopback" connection is used for establishing the connection which cannot be accessed outside the JVM or the running machine.
LoopbackBytesTransceiver	A LoopbackBytesTransceiver is a DatagramTransceiver connected directly within the same JVM with another LoopbackBytesTransceiver; a "loopback" connection is used for establishing the connection which cannot be accessed outside the JVM or the running machine.
LoopbackBytesTransmitter	A LoopbackBytesTransmitter is a DatagramTransmitter connected directly within the same JVM with a LoopbackBytesReceiver; a "loopback" connection is used for establishing the connection which cannot be accessed outside the JVM or the running machine.
LoopbackDatagramsReceiver<DATA extends Serializable>	A LoopbackDatagramsReceiver is a DatagramReceiver connected directly within the same JVM with a LoopbackDatagramsTransmitter; a "loopback" connection is used for establishing the connection which cannot be accessed outside the JVM or the running machine.
LoopbackDatagramsTransceiver<DATA extends Serializable>	A LoopbackDatagramsTransceiver is a DatagramTransceiver connected directly within the same JVM with another LoopbackDatagramsTransceiver; a "loopback" connection is used for establishing the connection which cannot be accessed outside the JVM or the running machine.
LoopbackDatagramsTransmitter<DATA extends Serializable>	A LoopbackDatagramsTransmitter is a DatagramTransmitter connected directly within the same JVM with a LoopbackDatagramsReceiver; a "loopback" connection is used for establishing the connection which cannot be accessed outside the JVM or the running machine.
LoopbackShortsReceiver	A LoopbackShortsReceiver is a DatagramReceiver connected directly within the same JVM with a LoopbackShortsTransmitter; a "loopback" connection is used for establishing the connection which cannot be accessed outside the JVM or the running machine.
LoopbackShortsTransceiver	A LoopbackShortsTransceiver is a DatagramTransceiver connected directly within the same JVM with another LoopbackShortsTransceiver; a "loopback" connection is used for establishing the connection which cannot be accessed outside the JVM or the running machine.
LoopbackShortsTransmitter	A LoopbackShortsTransmitter is a DatagramTransmitter connected directly within the same JVM with a LoopbackBytesReceiver; a "loopback" connection is used for establishing the connection which cannot be accessed outside the JVM or the running machine.
MaxConnectionsAccessor	Provides an accessor for a maximum connections property.
MaxConnectionsAccessor.MaxConnectionsBuilder<B extends MaxConnectionsAccessor.MaxConnectionsBuilder<B>>	Provides a builder method for a maximum connections property returning the builder for applying multiple build operations.
MaxConnectionsAccessor.MaxConnectionsMutator	Provides a mutator for a maximum connections property.
MaxConnectionsAccessor.MaxConnectionsProperty	Provides a maximum connections property.
OutputStreamBytesTransmitter	The Class OutputStreamBytesTransmitter.
OutputStreamConnectionBytesTransmitter	A OutputStreamConnectionBytesTransmitter is a DatagramTransmitter connected through I/O streams with a InputStreamConnectionReceiver.
OutputStreamConnectionDatagramsTransmitter<DATA extends Serializable>	A OutputStreamConnectionDatagramsTransmitter is a DatagramTransmitter connected through I/O streams with a InputStreamConnectionReceiver.
OutputStreamConnectionShortsTransmitter	A OutputStreamConnectionShortsTransmitter is a DatagramTransmitter connected through I/O streams with a InputStreamConnectionReceiver.
OutputStreamDatagramsTransmitter<DATA extends Serializable>	The Class OutputStreamDatagramsTransmitter.
OutputStreamShortsTransmitter	The Class OutputStreamShortsTransmitter.
PrefetchBidirectionalStreamByteTransceiver	The Class PrefetchBidirectionalStreamByteTransceiver.
PrefetchBidirectionalStreamConnectionByteTransceiver	The Class PrefetchBidirectionalStreamConnectionByteTransceiver.
PrefetchBidirectionalStreamConnectionTransceiver<DATA extends Serializable>	The Class PrefetchBidirectionalStreamConnectionTransceiver.
PrefetchBidirectionalStreamTransceiver<DATA extends Serializable>	The Class PrefetchBidirectionalStreamTransceiver.
PrefetchInputStreamByteReceiver	The Class PrefetchInputStreamByteReceiver.
PrefetchInputStreamConnectionByteReceiver	Implementation of the InputStreamConnectionReceiver interface.
PrefetchInputStreamConnectionReceiver<DATA extends Serializable>	Implementation of the InputStreamConnectionReceiver interface.
PrefetchInputStreamReceiver<DATA extends Serializable>	The Class PrefetchInputStreamReceiver.
Receivable	The Interface Receivable.
ReplaceInputStream	The ReplaceInputStream replaces a give byte sequence with another given bytes sequence.
ReplayInputStream	The ReplayInputStream wraps an InputStream adding ReplayInputStream.mark(int), ReplayInputStream.markSupported() as well as ReplayInputStream.reset() functionality, similar to the BufferedInputStream.
RowReader<T>	A RowReader reads a set of elements (a row) from an external source.
RowWriter<T>	A RowWriter writes a set of elements (a row) to an external destination.
SerializableIterator<T>	Makes the wrapped Iterator serializable, else passing Iterator instances would cause an NotSerializableException or similar.
SerializableListIterator<T>	Makes the wrapped ListIterator serializable, else passing ListIterator instances would cause an NotSerializableException or similar.
SerializableObjectInputStream	The SerializableObjectInputStream extends an ordinary ObjectInputStream to also resolve primitive types.
ShortArrayReceiver	The Class ShortArrayReceiver.
ShortArraySource	The Class ShortArraySource.
ShortDestination	The ShortDestination is used to receive shorts in a unified way.
ShortReceiver	The ShortReceiver is used to receive shot values in a unified way.
ShortsDestination	The ShortsDestination is used to receive short blocks (arrays) in a unified way.
ShortSource	The ShortSource is used to send shorts in a unified way.
ShortsReceiver	The Interface ShortsReceiver.
ShortsReceiverDecorator	The ShortsReceiverDecorator decorates a ShortsDestination with the additional methods of a ShortsReceiver making it easy to use a ShortsDestination wherever a ShortsReceiver is expected.
ShortsSource	The ShortsSource is used to send short blocks (arrays) in a unified way.
ShortsTransceiver	A ShortsTransceiver combines the functionality of a ShortsTransmitter and of a ShortsReceiver. e.g. for building loopback devices.
ShortsTransmitter	The ShortsTransmitter is used to send short blocks (arrays) in a unified way.
ShortTransceiver	Combines the ShortTransmitter and ShortReceiver functionality in a single interface to be implemented by a single class so that ShortsTransmitter and ShortReceiver functionality can be provided by a single instance.
ShortTransmitter	The Interface ShortsTransmitter.
ShortTransmitterDecorator	The ShortTransmitterDecorator decorates a ShortsSource with the additional methods of a ShortsTransmitter making it easy to use a ShortsSource wherever a ShortsTransmitter is expected.
SkipAvailableInputStream	The SkipAvailableInputStream decorates an InputStream with skip timed functionality, e.g. skip all currently available bytes (Skippable.skipAvailable()), all bytes available for a period of time (SkipAvailableInputStream.skipAvailableWithin(long)) or skip all bytes available till a send pause of a given time is detected (SkipAvailableInputStream.skipAvailableTillSilenceFor(long) or Skippable.skipAvailableTillSilenceFor(long, long)).
Skippable	The Skippable interface defines methods useful for omitting bytes known to be unusable for the according operation.
TimeoutInputStream	The TimeoutInputStream decorates an InputStream with time-out functionality using CompletableFuture functionality.
TimeoutInputStreamAccessor	Provides an accessor for an timeout input stream property.
TimeoutInputStreamAccessor.TimeoutInputStreamBuilder<B extends TimeoutInputStreamAccessor.TimeoutInputStreamBuilder<?>>	Provides a mutator for an timeout input stream property.
TimeoutInputStreamAccessor.TimeoutInputStreamMutator	Provides a mutator for an timeout input stream property.
TimeoutInputStreamAccessor.TimeoutInputStreamProperty	Provides an timeout input stream property.
Transmittable	The Interface Transmittable.
TransmitterDecorator<DATA extends Serializable>	The TransmitterDecorator decorates a DatagramsSource with the additional methods of a DatagramsTransmitter making it easy to use a DatagramsSource wherever a DatagramsTransmitter is expected.
ZipFileInputStream	Represents an InputStream from a provided File: In case the file points to a ZIP compressed file, then the uncompressed data of the therein contained file with the same name excluding the ".zip" extension is provided by the InputStream.
ZipFileOutputStream	Represents an OutputStream to a provided File: In case the file points to a ZIP compressed file, then a therein to be contained file with the same name excluding the ".zip" extension is created by the OutputStream.
ZipUtility	Utility class for some ZIP compression related issues.