Module org.refcodes.io
Package org.refcodes.io
-
Interface Summary Interface Description Availability TheAvailability
interface defines methods to test availability of data.BidirectionalConnectionByteTransceiver<INPUT,OUTPUT> TheBidirectionalConnectionByteTransceiver
defines theDatagramTransceiver
functionality set on top of a I/O connection (as of theBidirectionalConnectionComponent.BidirectionalConnectionAutomaton
).BidirectionalConnectionTransceiver<DATA extends Serializable,INPUT,OUTPUT> TheBidirectionalConnectionTransceiver
defines theDatagramTransceiver
functionality set on top of a I/O connection (as of theBidirectionalConnectionComponent.BidirectionalConnectionAutomaton
).BidirectionalStreamConnectionByteTransceiver ABidirectionalStreamConnectionByteTransceiver
is aDatagramTransceiver
connected through I/O streams with anotherBidirectionalStreamConnectionByteTransceiver
.BidirectionalStreamConnectionTransceiver<DATA extends Serializable> ABidirectionalStreamConnectionTransceiver
is aDatagramTransceiver
connected through I/O streams with anotherBidirectionalStreamConnectionTransceiver
.ByteDestination TheByteDestination
is used to receive bytes in a unified way.ByteReceiver TheByteReceiver
is used to receive bytes in a unified way.BytesDestination TheBytesDestination
is used to receive byte blocks (arrays) in a unified way.BytesInputStream (asInputStream
does not provide some useful *interface*)ByteSource TheByteSource
is used to send bytes in a unified way.BytesOutputStream (asOutputStream
does not provide some useful *interface*)BytesReceiver The Interface BytesReceiver.BytesSource TheBytesSource
is used to send byte blocks (arrays) in a unified way.BytesTransceiver ABytesTransceiver
combines the functionality of aBytesTransmitter
and of aBytesReceiver
. e.g. for building loopback devices.BytesTransmitter The Interface BytesTransmitter.ByteTransceiver Combines theByteTransmitter
andByteReceiver
functionality in a single interface to be implemented by a single class so thatByteTransmitter
andByteReceiver
functionality can be provided by a single instance.ByteTransmitter TheByteTransmitter
is used to transmit bytes in a unified way.ConnectionBytesReceiver<CON> TheConnectionBytesReceiver
defines theDatagramReceiver
functionality set on top of a connection (as of theConnectionComponent.ConnectionAutomaton
) for data types "byte".ConnectionBytesTransceiver<CON> TheConnectionBytesTransceiver
defines theDatagramTransceiver
functionality set on top of a connection (as of theConnectionComponent.ConnectionAutomaton
) for data types "byte".ConnectionBytesTransmitter<CON> TheConnectionBytesTransmitter
defines theDatagramTransmitter
functionality set on top of a connection (as of theConnectionComponent.ConnectionAutomaton
) for data types "byte".ConnectionDatagramsReceiver<DATA extends Serializable,CON> TheConnectionDatagramsReceiver
defines theDatagramReceiver
functionality set on top of a connection (as of theConnectionComponent.ConnectionAutomaton
).ConnectionDatagramsTransceiver<DATA extends Serializable,CON> TheConnectionDatagramsTransceiver
defines theDatagramTransceiver
functionality set on top of a connection (as of theConnectionComponent.ConnectionAutomaton
).ConnectionDatagramsTransmitter<DATA extends Serializable,CON> TheConnectionDatagramsTransmitter
defines theDatagramTransmitter
functionality set on top of a connection (as of theConnectionComponent.ConnectionAutomaton
).ConnectionShortsReceiver<CON> TheConnectionShortsReceiver
defines theDatagramReceiver
functionality set on top of a connection (as of theConnectionComponent.ConnectionAutomaton
) for data types "short".ConnectionShortsTransceiver<CON> TheConnectionShortsTransceiver
defines theDatagramTransceiver
functionality set on top of a connection (as of theConnectionComponent.ConnectionAutomaton
) for data types "short".ConnectionShortsTransmitter<CON> TheConnectionShortsTransmitter
defines theDatagramTransmitter
functionality set on top of a connection (as of theConnectionComponent.ConnectionAutomaton
) for data types "short".DatagramDestination<DATA extends Serializable> TheDatagramDestination
is used to receive datagrams in a unified way.DatagramReceiver<DATA extends Serializable> TheDatagramReceiver
is used to receive datagrams in a unified way.DatagramsDestination<DATA extends Serializable> TheDatagramsDestination
is used to receive data blocks (arrays) in a unified way.DatagramSource<DATA extends Serializable> TheDatagramSource
is used to send datagrams in a unified way.DatagramsReceiver<DATA extends Serializable> The Interface DatagramsReceiver.DatagramsSource<DATA extends Serializable> TheDatagramsSource
is used to send datagram blocks (arrays) in a unified way.DatagramsTransceiver<DATA extends Serializable> ADatagramsTransceiver
combines the functionality of aDatagramsTransmitter
and of aDatagramsReceiver
. e.g. for building loopback devices.DatagramsTransmitter<DATA extends Serializable> TheDatagramsTransmitter
is used to send datagram blocks (arrays) in a unified way.DatagramTransceiver<DATA extends Serializable> Combines theDatagramTransmitter
andDatagramReceiver
functionality in a single interface to be implemented by a single class so thatDatagramTransmitter
andDatagramReceiver
functionality can be provided by a single instance.DatagramTransmitter<DATA extends Serializable> TheDatagramTransmitter
is used to send datagrams in a unified way.InputStreamConnectionByteReceiver AInputStreamConnectionByteReceiver
is aDatagramReceiver
connected through I/O streams with aOutputStreamConnectionDatagramsTransmitter
.InputStreamConnectionReceiver<DATA extends Serializable> AInputStreamConnectionReceiver
is aDatagramReceiver
connected through I/O streams with aOutputStreamConnectionDatagramsTransmitter
.IoResultAccessor<RES,EXC extends Exception> Extends theResultAccessor
interface with an I/O timeout mechanism.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.Receivable The Interface Receivable.RowReader<T> ARowReader
reads a set of elements (a row) from an external source.RowWriter<T> ARowWriter
writes a set of elements (a row) to an external destination.ShortDestination TheShortDestination
is used to receive shorts in a unified way.ShortReceiver TheShortReceiver
is used to receive shot values in a unified way.ShortsDestination TheShortsDestination
is used to receive short blocks (arrays) in a unified way.ShortSource TheShortSource
is used to send shorts in a unified way.ShortsReceiver The Interface ShortsReceiver.ShortsSource TheShortsSource
is used to send short blocks (arrays) in a unified way.ShortsTransceiver AShortsTransceiver
combines the functionality of aShortsTransmitter
and of aShortsReceiver
. e.g. for building loopback devices.ShortsTransmitter TheShortsTransmitter
is used to send short blocks (arrays) in a unified way.ShortTransceiver Combines theShortTransmitter
andShortReceiver
functionality in a single interface to be implemented by a single class so thatShortsTransmitter
andShortReceiver
functionality can be provided by a single instance.ShortTransmitter The Interface ShortsTransmitter.Skippable TheSkippable
interface defines methods useful for omitting bytes known to be unusable for the according operation.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. -
Class Summary Class Description AbstractBytesDestination TheAbstractBytesDestination
is a base abstract implementation of theBytesDestination
interface providing common functionality for concrete real implementations.AbstractBytesReceiver TheAbstractBytesReceiver
is a base abstract implementation of theBytesReceiver
interface providing common functionality for concrete real live implementations.AbstractBytesReceiver.ConnectableAutomaton The Class ConnectableAutomaton.AbstractBytesTransmitter TheAbstractBytesTransmitter
is a base abstract implementation of theBytesTransmitter
interface providing common functionality for concrete real live implementations.AbstractDatagramsReceiver<DATA extends Serializable> TheAbstractDatagramsReceiver
is a base abstract implementation of theDatagramsReceiver
interface providing common functionality for concrete real live implementations.AbstractDatagramsTransmitter<DATA extends Serializable> TheAbstractDatagramsTransmitter
is a base abstract implementation of theBytesTransmitter
interface providing common functionality for concrete real live implementations.AbstractInputStreamByteReceiver Abstract implementation of theBytesReceiver
interface.AbstractInputStreamReceiver<DATA extends Serializable> Abstract implementation of theDatagramsReceiver
interface.AbstractPrefetchInputStreamByteReceiver Abstract implementation of theBytesReceiver
interface.AbstractPrefetchInputStreamReceiver<DATA extends Serializable> Abstract implementation of theDatagramsReceiver
interface.AbstractShortsDestination TheAbstractShortsDestination
is a base abstract implementation of theShortsDestination
interface providing common functionality for concrete real live implementations.AbstractShortsReceiver TheAbstractShortsReceiver
is a base abstract implementation of theShortsReceiver
interface providing common functionality for concrete real live implementations.AbstractShortsReceiver.ConnectableAutomaton The Class ConnectableAutomaton.AbstractShortsTransmitter TheAbstractShortsTransmitter
is a base abstract implementation of theShortsTransmitter
interface providing common functionality for concrete real liveShortsTransmitter
andShortsTransmitter
(=ShortsTransmitter
) implementations.BidirectionalStreamByteTransceiver The Class BidirectionalStreamByteTransceiver.BidirectionalStreamConnectionByteTransceiverImpl The Class BidirectionalStreamConnectionByteTransceiverImpl.BidirectionalStreamConnectionTransceiverImpl<DATA extends Serializable> The Class BidirectionalStreamConnectionTransceiverImpl.BidirectionalStreamTransceiver<DATA extends Serializable> The Class BidirectionalStreamTransceiver.BijectiveOutputStream ABijectiveOutputStream
wraps anOutputStream
and produces output bytes by applying aBijectiveFunction
on each byte to be written before delegating the processed vale to the givenOutputStream
.BoundedInputStream ABoundedInputStream
decorates anInputStream
and restricts reading bytes from theInputStream
decoratee up to a given total number of bytes (bounds).ByteArrayReceiver The Class ByteArrayReceiver.ByteArraySource The Class ByteArraySource.BytesReceiver.ReceiverInputStream BytesReceiverDecorator TheBytesReceiverDecorator
decorates aBytesDestination
with the additional methods of aBytesReceiver
making it easy to use aBytesDestination
wherever aBytesReceiver
is expected.BytesTransmitter.TransmitterOutputStream ByteTransmitterDecorator TheByteTransmitterDecorator
decorates aBytesSource
with the additional methods of aBytesTransmitter
making it easy to use aBytesSource
wherever aBytesTransmitter
is expected.DatagramsReceiverDecorator<DATA extends Serializable> TheDatagramsReceiverDecorator
decorates aDatagramsDestination
with the additional methods of aDatagramsReceiver
making it easy to use aDatagramsDestination
wherever aDatagramsReceiver
is expected.FileUtility TheFileUtility
provides Various file related utility functionality.InputStreamByteReceiver The Class InputStreamByteReceiver.InputStreamConnectionByteReceiverImpl Implementation of theInputStreamConnectionReceiver
interface.InputStreamConnectionReceiverImpl<DATA extends Serializable> Implementation of theInputStreamConnectionReceiver
interface.InputStreamReceiver<DATA extends Serializable> The Class InputStreamReceiver.InputStreamStringBuilder InverseInputStream AInverseInputStream
wraps anInputStream
and consumes input bytes by applying aInverseFunction
on each byte read from the providedInputStream
before passing back the processed byte to the caller.LineBreakOutputStream ALineBreakOutputStream
wraps anOutputStream
for adding line breaks after a given number of bytes being written.LoopbackBytesReceiver ALoopbackBytesReceiver
is aDatagramReceiver
connected directly within the same JVM with aLoopbackBytesTransmitter
; a "loopback" connection is used for establishing the connection which cannot be accessed outside the JVM or the running machine.LoopbackBytesTransceiver ALoopbackBytesTransceiver
is aDatagramTransceiver
connected directly within the same JVM with anotherLoopbackBytesTransceiver
; a "loopback" connection is used for establishing the connection which cannot be accessed outside the JVM or the running machine.LoopbackBytesTransmitter ALoopbackBytesTransmitter
is aDatagramTransmitter
connected directly within the same JVM with aLoopbackBytesReceiver
; a "loopback" connection is used for establishing the connection which cannot be accessed outside the JVM or the running machine.LoopbackDatagramsReceiver<DATA extends Serializable> ALoopbackDatagramsReceiver
is aDatagramReceiver
connected directly within the same JVM with aLoopbackDatagramsTransmitter
; a "loopback" connection is used for establishing the connection which cannot be accessed outside the JVM or the running machine.LoopbackDatagramsTransceiver<DATA extends Serializable> ALoopbackDatagramsTransceiver
is aDatagramTransceiver
connected directly within the same JVM with anotherLoopbackDatagramsTransceiver
; a "loopback" connection is used for establishing the connection which cannot be accessed outside the JVM or the running machine.LoopbackDatagramsTransmitter<DATA extends Serializable> ALoopbackDatagramsTransmitter
is aDatagramTransmitter
connected directly within the same JVM with aLoopbackDatagramsReceiver
; a "loopback" connection is used for establishing the connection which cannot be accessed outside the JVM or the running machine.LoopbackShortsReceiver ALoopbackShortsReceiver
is aDatagramReceiver
connected directly within the same JVM with aLoopbackShortsTransmitter
; a "loopback" connection is used for establishing the connection which cannot be accessed outside the JVM or the running machine.LoopbackShortsTransceiver ALoopbackShortsTransceiver
is aDatagramTransceiver
connected directly within the same JVM with anotherLoopbackShortsTransceiver
; a "loopback" connection is used for establishing the connection which cannot be accessed outside the JVM or the running machine.LoopbackShortsTransmitter ALoopbackShortsTransmitter
is aDatagramTransmitter
connected directly within the same JVM with aLoopbackBytesReceiver
; a "loopback" connection is used for establishing the connection which cannot be accessed outside the JVM or the running machine.OutputStreamBytesTransmitter The Class OutputStreamBytesTransmitter.OutputStreamConnectionBytesTransmitter AOutputStreamConnectionBytesTransmitter
is aDatagramTransmitter
connected through I/O streams with aInputStreamConnectionReceiver
.OutputStreamConnectionDatagramsTransmitter<DATA extends Serializable> AOutputStreamConnectionDatagramsTransmitter
is aDatagramTransmitter
connected through I/O streams with aInputStreamConnectionReceiver
.OutputStreamConnectionShortsTransmitter AOutputStreamConnectionShortsTransmitter
is aDatagramTransmitter
connected through I/O streams with aInputStreamConnectionReceiver
.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 theInputStreamConnectionReceiver
interface.PrefetchInputStreamConnectionReceiver<DATA extends Serializable> Implementation of theInputStreamConnectionReceiver
interface.PrefetchInputStreamReceiver<DATA extends Serializable> The Class PrefetchInputStreamReceiver.SerializableIterator<T> Makes the wrappedIterator
serializable, else passingIterator
instances would cause anNotSerializableException
or similar.SerializableListIterator<T> Makes the wrappedListIterator
serializable, else passingListIterator
instances would cause anNotSerializableException
or similar.SerializableObjectInputStream TheSerializableObjectInputStream
extends an ordinaryObjectInputStream
to also resolve primitive types.ShortArrayReceiver The Class ShortArrayReceiver.ShortArraySource The Class ShortArraySource.ShortsReceiverDecorator TheShortsReceiverDecorator
decorates aShortsDestination
with the additional methods of aShortsReceiver
making it easy to use aShortsDestination
wherever aShortsReceiver
is expected.ShortTransmitterDecorator TheShortTransmitterDecorator
decorates aShortsSource
with the additional methods of aShortsTransmitter
making it easy to use aShortsSource
wherever aShortsTransmitter
is expected.SkipAvailableInputStream TheSkipAvailableInputStream
decorates anInputStream
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)
orSkippable.skipAvailableTillSilenceFor(long, long)
).TimeoutInputStream TheTimeoutInputStream
decorates anInputStream
with time-out functionality.TimeoutInputStream.DummyTimeoutInputStream Dummy implementation of aTimeoutInputStream
directly delegating to the givenInputStream
to test whether theTimeoutInputStream
has any latencies compared to theTimeoutInputStream.DummyTimeoutInputStream
.TransmitterDecorator<DATA extends Serializable> TheTransmitterDecorator
decorates aDatagramsSource
with the additional methods of aDatagramsTransmitter
making it easy to use aDatagramsSource
wherever aDatagramsTransmitter
is expected.ZipFileInputStream Represents anInputStream
from a providedFile
: 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 theInputStream
.ZipFileOutputStream Represents anOutputStream
to a providedFile
: 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 theOutputStream
.ZipUtility Utility class for some ZIP compression related issues.