net.lecousin.framework.io

Interface IO.ReadableByteStream

All Superinterfaces:

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

All Known Subinterfaces:

IO.Readable.Buffered

All Known Implementing Classes:

BufferedIO, BufferedIO.ReadWrite, BufferedReverseIOReading, ByteArrayIO, ByteBuffersIO, EmptyReadable, LinkedIO.Readable.Buffered, LinkedIO.Readable.Buffered.DeterminedSize, LinkedIO.Readable.Seekable.Buffered, LinkedIO.Readable.Seekable.Buffered.DeterminedSize, MemoryIO, NonBufferedReadableIOAsBuffered, OutputToInputBuffers, PositionKnownWrapper.Readable.Buffered, PreBufferedReadable, ReadableToSeekable, SimpleBufferedReadable, SingleBufferReadable, SubIO.Readable.Seekable.Buffered, TwoBuffersIO, TwoBuffersIO.DeterminedSize

Enclosing interface:

IO

public static interface IO.ReadableByteStream
extends IO

Add capability to read byte by byte, typically a buffered IO.

Nested Class Summary

Nested classes/interfaces inherited from interface net.lecousin.framework.io.IO

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

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

CloseableListenable.Impl

Method Summary

Modifier and Type	Method and Description
IAsync<IOException>	canStartReading() Return a synchronization point that is unblocked when data is ready to be read.
int	read() Read next byte.
int	read(byte[] buffer, int offset, int len) Read bytes into the given buffer, starting to store them at the given offset, and with the given maximum number of bytes.
default byte	readByte() Similar to read, but returns a byte and throw an EOFException in case the end is reached.
int	readFully(byte[] buffer) Read bytes to fill the given buffer, and return the number of bytes read which is less than the size of the buffer only if the end of the IO is reached, and so may return 0.
int	skip(int skip) Same as IO.Readable.skipSync(long) but limited to an integer.

Methods inherited from interface net.lecousin.framework.io.IO

cancelClosed, error, errorCancelled, getPriority, getSourceDescription, getTaskManager, getWrappedIO, setPriority

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

canStartReading

IAsync<IOException> canStartReading()

Return a synchronization point that is unblocked when data is ready to be read. This allows to start reading operations only when we know it won't block.

read

int read()
  throws IOException

Read next byte. Return -1 if the end of the IO is reached, or the value between 0 and 255.

Throws:

IOException

read

int read(byte[] buffer,
         int offset,
         int len)
  throws IOException

Read bytes into the given buffer, starting to store them at the given offset, and with the given maximum number of bytes. Returns the number of bytes read, or 0 or -1 if the end of the IO is reached.

Throws:

IOException

readFully

int readFully(byte[] buffer)
       throws IOException

Read bytes to fill the given buffer, and return the number of bytes read which is less than the size of the buffer only if the end of the IO is reached, and so may return 0.

Throws:

IOException

readByte

default byte readByte()
               throws IOException

Similar to read, but returns a byte and throw an EOFException in case the end is reached.

Throws:

IOException

skip

int skip(int skip)
  throws IOException

Same as IO.Readable.skipSync(long) but limited to an integer.

Throws:

IOException