net.lecousin.framework.io.text

Interface ICharacterStream.Readable

All Superinterfaces:

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

All Known Subinterfaces:

ICharacterStream.Readable.Buffered, ICharacterStream.Readable.PositionInText

All Known Implementing Classes:

BufferedReadableCharacterStream, BufferedReadableCharacterStreamLocation, ProgressiveBufferedReadableCharStream, UnprotectedStringBuffer.CS

Enclosing interface:

ICharacterStream

public static interface ICharacterStream.Readable
extends ICharacterStream

Readable character stream.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ICharacterStream.Readable.Buffered Buffered readable character stream.
static interface	ICharacterStream.Readable.PositionInText Readable character stream with known line and position in line.

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

ICharacterStream.Readable, ICharacterStream.Writable, ICharacterStream.WriterAsync

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

CloseableListenable.Impl

Method Summary

Modifier and Type	Method and Description
boolean	endReached() Return true if the end of the stream has been reached, and no more character can be read.
AsyncSupplier<Integer,IOException>	readAsync(char[] buf, int offset, int length) Read characters.
default AsyncSupplier<Integer,IOException>	readFullyAsync(char[] buf, int offset, int length) Read all requested characters.
default int	readFullySync(char[] buf, int offset, int length) Read all requested characters.
int	readSync(char[] buf, int offset, int length) Read characters.

Methods inherited from interface net.lecousin.framework.io.text.ICharacterStream

getDescription, getEncoding, getPriority, 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

readSync

int readSync(char[] buf,
             int offset,
             int length)
      throws IOException

Read characters.

Returns:

the number of character read which may be 0 or -1 in case the end of stream has been reached

Throws:

IOException

readAsync

AsyncSupplier<Integer,IOException> readAsync(char[] buf,
                                             int offset,
                                             int length)

Read characters.

Returns:

the number of character read which may be 0 or -1 in case the end of stream has been reached

endReached

boolean endReached()

Return true if the end of the stream has been reached, and no more character can be read.

readFullySync

default int readFullySync(char[] buf,
                          int offset,
                          int length)
                   throws IOException

Read all requested characters.

Throws:

IOException

readFullyAsync

default AsyncSupplier<Integer,IOException> readFullyAsync(char[] buf,
                                                          int offset,
                                                          int length)

Read all requested characters.