net.lecousin.framework.io.text

Class ProgressiveBufferedReadableCharStream

java.lang.Object

net.lecousin.framework.util.ConcurrentCloseable<IOException>

net.lecousin.framework.io.text.ProgressiveBufferedReadableCharStream

All Implemented Interfaces:

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

public class ProgressiveBufferedReadableCharStream
extends ConcurrentCloseable<IOException>
implements ICharacterStream.Readable.Buffered

Buffered readable character stream. The decoding is done in a separate task, as usual in buffered implementations. The difference with other implementations is that when a character is needed and no more available decoded characters, the decoding task makes a buffer available as soon as possible, even if the buffer is not fully decoded, making characters available sooner.

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

Constructor Summary

Constructors

Constructor and Description
ProgressiveBufferedReadableCharStream(Decoder decoder, int bufferSize, int maxBuffers) Constructor.
ProgressiveBufferedReadableCharStream(Decoder decoder, int bufferSize, int maxBuffers, CharBuffer firstChars) Constructor.

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.
protected void	closeResources(Async<IOException> ondone)
protected IAsync<IOException>	closeUnderlyingResources()
boolean	endReached() Return true if the end of the stream has been reached, and no more character can be read.
String	getDescription() Description.
Charset	getEncoding() Return the encoding of the stream.
byte	getPriority() Return the priority.
char	read() Read one character.
int	readAsync() Read one character if possible.
AsyncSupplier<Integer,IOException>	readAsync(char[] buf, int offset, int length) Read characters.
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.
int	readSync(char[] buf, int offset, int length) Read characters.
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.
void	setPriority(byte priority) Change the priority (see Task priorities).

Methods inherited from class net.lecousin.framework.util.ConcurrentCloseable

addCloseListener, addCloseListener, close, closeAsync, isClosed, isClosing, lockClose, operation, operation, removeCloseListener, removeCloseListener, unlockClose

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

readFullyAsync, readFullySync

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

Constructor Detail

ProgressiveBufferedReadableCharStream

public ProgressiveBufferedReadableCharStream(Decoder decoder,
                                             int bufferSize,
                                             int maxBuffers)

Constructor.

ProgressiveBufferedReadableCharStream

public ProgressiveBufferedReadableCharStream(Decoder decoder,
                                             int bufferSize,
                                             int maxBuffers,
                                             CharBuffer firstChars)

Constructor.

Method Detail

back

public void back(char c)

Description copied from interface: ICharacterStream.Readable.Buffered

Put back one character.

Specified by:

back in interface ICharacterStream.Readable.Buffered

read

public char read()
          throws IOException

Description copied from interface: ICharacterStream.Readable.Buffered

Read one character.

Specified by:

read in interface ICharacterStream.Readable.Buffered

Throws:

IOException

readSync

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

Description copied from interface: ICharacterStream.Readable

Read characters.

Specified by:

readSync in interface ICharacterStream.Readable

Returns:

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

Throws:

IOException

canStartReading

public IAsync<IOException> canStartReading()

Description copied from interface: ICharacterStream.Readable.Buffered

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

Specified by:

canStartReading in interface ICharacterStream.Readable.Buffered

readAsync

public int readAsync()
              throws IOException

Description copied from interface: ICharacterStream.Readable.Buffered

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.

Specified by:

readAsync in interface ICharacterStream.Readable.Buffered

Throws:

IOException

readAsync

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

Description copied from interface: ICharacterStream.Readable

Read characters.

Specified by:

readAsync in interface ICharacterStream.Readable

Returns:

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

readNextBufferAsync

public AsyncSupplier<UnprotectedString,IOException> readNextBufferAsync()

Description copied from interface: ICharacterStream.Readable.Buffered

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

Specified by:

readNextBufferAsync in interface ICharacterStream.Readable.Buffered

readNextBuffer

public UnprotectedString readNextBuffer()
                                 throws IOException

Description copied from interface: ICharacterStream.Readable.Buffered

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

Specified by:

readNextBuffer in interface ICharacterStream.Readable.Buffered

Throws:

IOException

readUntil

public boolean readUntil(char endChar,
                         UnprotectedStringBuffer string)
                  throws IOException

Description copied from interface: ICharacterStream.Readable.Buffered

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.

Specified by:

readUntil in interface ICharacterStream.Readable.Buffered

Throws:

IOException

readUntilAsync

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

Description copied from interface: ICharacterStream.Readable.Buffered

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.

Specified by:

readUntilAsync in interface ICharacterStream.Readable.Buffered

endReached

public boolean endReached()

Description copied from interface: ICharacterStream.Readable

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

Specified by:

endReached in interface ICharacterStream.Readable

getEncoding

public Charset getEncoding()

Description copied from interface: ICharacterStream

Return the encoding of the stream.

Specified by:

getEncoding in interface ICharacterStream

getPriority

public byte getPriority()

Description copied from class: ConcurrentCloseable

Return the priority.

Specified by:

getPriority in interface ICharacterStream

Specified by:

getPriority in class ConcurrentCloseable<IOException>

setPriority

public void setPriority(byte priority)

Description copied from interface: ICharacterStream

Change the priority (see Task priorities).

Specified by:

setPriority in interface ICharacterStream

getDescription

public String getDescription()

Description copied from interface: ICharacterStream

Description.

Specified by:

getDescription in interface ICharacterStream

closeUnderlyingResources

protected IAsync<IOException> closeUnderlyingResources()

Specified by:

closeUnderlyingResources in class ConcurrentCloseable<IOException>

closeResources

protected void closeResources(Async<IOException> ondone)

Specified by:

closeResources in class ConcurrentCloseable<IOException>