net.lecousin.framework.io

Interface IO

All Superinterfaces:

AsyncCloseable<IOException>, AutoCloseable, CloseableListenable, IConcurrentCloseable<IOException>

All Known Subinterfaces:

IO.KnownSize, IO.OutputToInput, IO.PositionKnown, IO.Readable, IO.Readable.Buffered, IO.Readable.Seekable, IO.ReadableByteStream, IO.Resizable, IO.Seekable, IO.Writable, IO.Writable.Buffered, IO.Writable.Seekable, IO.WritableByteStream

All Known Implementing Classes:

AbstractIO, BroadcastIO, BufferedIO, BufferedIO.ReadWrite, BufferedReverseIOReading, ByteArrayIO, ByteBuffersIO, EmptyReadable, FileIO, FileIO.ReadOnly, FileIO.ReadWrite, FileIO.WriteOnly, FragmentedSubIO, FragmentedSubIO.Readable, FragmentedSubIO.ReadWrite, IOFromInputStream, IOFromInputStream.KnownSize, IOFromOutputStream, IOInMemoryOrFile, LinkedIO, LinkedIO.Readable, LinkedIO.Readable.Buffered, LinkedIO.Readable.Buffered.DeterminedSize, LinkedIO.Readable.DeterminedSize, LinkedIO.Readable.Seekable, LinkedIO.Readable.Seekable.Buffered, LinkedIO.Readable.Seekable.Buffered.DeterminedSize, LinkedIO.Readable.Seekable.DeterminedSize, LinkedIO.ReadWrite, MemoryIO, NonBufferedReadableIOAsBuffered, OutputToInput, OutputToInputBuffers, PositionKnownWrapper, PositionKnownWrapper.Readable, PositionKnownWrapper.Readable.Buffered, PreBufferedReadable, ReadableSeekableToDeterminedSize, ReadableToSeekable, ReadableWithProgress, SimpleBufferedReadable, SimpleBufferedWritable, SingleBufferReadable, SubIO, SubIO.Readable, SubIO.Readable.Seekable, SubIO.Readable.Seekable.Buffered, SubIO.ReadWrite, SubIO.Writable, SubIO.Writable.Seekable, TwoBuffersIO, TwoBuffersIO.DeterminedSize

public interface IO
extends IConcurrentCloseable<IOException>

Base interface for all IO, see the package documentation net.lecousin.framework.io.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IO.KnownSize Add capability to know the size of an IO.
static class	IO.OperationType Synchronous ou asynchronous operation.
static interface	IO.OutputToInput An OutputToInput is an IO on which a producer is writing, and a consumer is reading. The producer receive it as a Writable, and the consumer as a Readable. Both can work concurrently: as soon as data is written by the producer, it can be read by the consumer. The producer must call the method endOfData or signalErrorBeforeEndOfData, so the consumer can receive the information it reaches the end of the IO. The implementations may add additional capabilities such as Readable.Seekable if it keeps the data.
static interface	IO.PositionKnown Capability to get the current position on an IO.
static interface	IO.Readable Add the capability to read forward on an IO.
static interface	IO.ReadableByteStream Add capability to read byte by byte, typically a buffered IO.
static interface	IO.Resizable Add capability to resize the IO.
static interface	IO.Seekable Capability to set the position on an IO.
static interface	IO.Writable Add the capability to write forward on an IO.
static interface	IO.WritableByteStream Add capability to write byte by byte.
static interface	IO.WriterAsync Simple interface for something to which we can write buffers asynchronously.

Nested classes/interfaces inherited from interface net.lecousin.framework.util.CloseableListenable

CloseableListenable.Impl

Method Summary

Modifier and Type	Method and Description
static CancelException	cancelClosed() Return a CancelException with message IO closed.
static IOException	error(Throwable e) Convert an Exception into an IOException.
static IOException	errorCancelled(CancelException e) Create an IOException from a CancelException.
byte	getPriority() Return the priority of asynchronous operations.
String	getSourceDescription() Describe the IO, which can be used for logging or debugging purposes.
TaskManager	getTaskManager() Return the TaskManager used for asynchronous operations.
IO	getWrappedIO() If this IO is wrapping another one (such as adding Buffered capabilities), this method returns it, or null if it does not wrap another IO.
void	setPriority(byte priority) Set the priority of asynchronous operations.

Methods inherited from interface net.lecousin.framework.util.IConcurrentCloseable

lockClose, unlockClose

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface net.lecousin.framework.util.AsyncCloseable

closeAfter, closeAsync

Methods inherited from interface net.lecousin.framework.util.CloseableListenable

addCloseListener, addCloseListener, close, isClosed, removeCloseListener, removeCloseListener

Method Detail

getSourceDescription

String getSourceDescription()

Describe the IO, which can be used for logging or debugging purposes.

getWrappedIO

IO getWrappedIO()

If this IO is wrapping another one (such as adding Buffered capabilities), this method returns it, or null if it does not wrap another IO.

getPriority

byte getPriority()

Return the priority of asynchronous operations.

setPriority

void setPriority(byte priority)

Set the priority of asynchronous operations.

getTaskManager

TaskManager getTaskManager()

Return the TaskManager used for asynchronous operations.

error

static IOException error(Throwable e)

Convert an Exception into an IOException. If thie given exception is already an IOException, it is directly returned.

errorCancelled

static IOException errorCancelled(CancelException e)

Create an IOException from a CancelException.

cancelClosed

static CancelException cancelClosed()

Return a CancelException with message IO closed.