net.lecousin.framework.io.text

Interface ICharacterStream.Readable.Buffered

All Superinterfaces:

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

All Known Implementing Classes:

BufferedReadableCharacterStream, BufferedReadableCharacterStreamLocation, ProgressiveBufferedReadableCharStream, UnprotectedStringBuffer.CS

Enclosing interface:

ICharacterStream.Readable

public static interface ICharacterStream.Readable.Buffered
extends ICharacterStream.Readable

Buffered readable character stream.

Nested Class Summary

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

ICharacterStream.Readable.Buffered, ICharacterStream.Readable.PositionInText

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
void	back(char c) Put back one character.
IAsync<IOException>	canStartReading() Return a synchronization point which is unblocked once some characters have been buffered.
char	read() Read one character.
int	readAsync() Read one character if possible.
UnprotectedString	readNextBuffer() Return the next buffer, or null if the end of stream has been reached.
AsyncSupplier<UnprotectedString,IOException>	readNextBufferAsync() Return the next buffer as soon as available, or null if then end of stream has been reached.
boolean	readUntil(char endChar, UnprotectedStringBuffer string) Read characters until the given end, and put them in the given string.
AsyncSupplier<Boolean,IOException>	readUntilAsync(char endChar, UnprotectedStringBuffer string) Read characters until the given end, and put them in the given string.

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

endReached, readAsync, readFullyAsync, readFullySync, readSync

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

canStartReading

IAsync<IOException> canStartReading()

Return a synchronization point which is unblocked once some characters have been buffered.

back

void back(char c)

Put back one character.

read

char read()
   throws IOException

Read one character.

Throws:

IOException

readAsync

int readAsync()
       throws IOException

Read one character if possible. If the end of stream is reached, -1 is returned. If no more character is available, but the end of stream is not yet reached, -2 is returned.

Throws:

IOException

readNextBuffer

UnprotectedString readNextBuffer()
                          throws IOException

Return the next buffer, or null if the end of stream has been reached.

Throws:

IOException

readNextBufferAsync

AsyncSupplier<UnprotectedString,IOException> readNextBufferAsync()

Return the next buffer as soon as available, or null if then end of stream has been reached.

readUntil

boolean readUntil(char endChar,
                  UnprotectedStringBuffer string)
           throws IOException

Read characters until the given end, and put them in the given string. It returns true if the endChar has been found (and is not included in the string), or false if the end of stream has been reached without the ending character.

Throws:

IOException

readUntilAsync

AsyncSupplier<Boolean,IOException> readUntilAsync(char endChar,
                                                  UnprotectedStringBuffer string)

Read characters until the given end, and put them in the given string. It returns true if the endChar has been found (and is not included in the string), or false if the end of stream has been reached without the ending character.