javolution.io

Class UTF8ByteBufferReader

java.lang.Object

java.io.Reader

javolution.io.UTF8ByteBufferReader

All Implemented Interfaces:

Closeable, AutoCloseable, Readable

public final class UTF8ByteBufferReader
extends Reader

A UTF-8 java.nio.ByteBuffer reader.

This reader can be used for efficient decoding of native byte buffers (e.g. MappedByteBuffer), high-performance messaging (no intermediate buffer), etc.

This reader supports surrogate char pairs (representing characters in the range [U+10000 .. U+10FFFF]). It can also be used to read characters unicodes (31 bits) directly (ref. read()).

Each invocation of one of the read() methods may cause one or more bytes to be read from the underlying byte buffer. The end of stream is reached when the byte buffer position and limit coincide.

Version:

2.0, December 9, 2004

Author:

Jean-Marie Dautelle

See Also:

UTF8ByteBufferWriter

Field Summary

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Constructor and Description
UTF8ByteBufferReader() Default constructor.
UTF8ByteBufferReader(ByteBuffer byteBuffer) Constructor for Initializing to Read from the Specified Byte Buffer

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes and resets this reader for reuse.
int	read() Reads a single character.
void	read(Appendable dest) Reads characters into the specified appendable.
int	read(char[] cbuf, int off, int len) Reads characters into a portion of an array.
boolean	ready() Indicates if this stream is ready to be read.
void	reset()
UTF8ByteBufferReader	setByteBuffer(ByteBuffer byteBuffer) Deprecated. Replaced by setInput(ByteBuffer)
UTF8ByteBufferReader	setInput(ByteBuffer byteBuffer) Sets the ByteBuffer to use for reading available bytes from current buffer position.

Methods inherited from class java.io.Reader

mark, markSupported, read, read, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

UTF8ByteBufferReader

public UTF8ByteBufferReader()

Default constructor.

UTF8ByteBufferReader

public UTF8ByteBufferReader(ByteBuffer byteBuffer)

Constructor for Initializing to Read from the Specified Byte Buffer

Parameters:

byteBuffer - ByteBuffer to Read From

Method Detail

setInput

public UTF8ByteBufferReader setInput(ByteBuffer byteBuffer)

Sets the ByteBuffer to use for reading available bytes from current buffer position.

Parameters:

byteBuffer - the ByteBuffer source.

Returns:

this UTF-8 reader.

Throws:

IllegalStateException - if this reader is being reused and it has not been closed or reset.

ready

public boolean ready()
              throws IOException

Indicates if this stream is ready to be read.

Overrides:

ready in class Reader

Returns:

true if the byte buffer has remaining bytes to read; false otherwise.

Throws:

IOException - if an I/O error occurs.

close

public void close()
           throws IOException

Closes and resets this reader for reuse.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Reader

Throws:

IOException - if an I/O error occurs.

read

public int read()
         throws IOException

Reads a single character. This method does not block, -1 is returned if the buffer's limit has been reached.

Overrides:

read in class Reader

Returns:

the 31-bits Unicode of the character read, or -1 if there is no more remaining bytes to be read.

Throws:

IOException - if an I/O error occurs (e.g. incomplete character sequence being read).

read

public int read(char[] cbuf,
       int off,
       int len)
         throws IOException

Reads characters into a portion of an array. This method does not block.

Note: Characters between U+10000 and U+10FFFF are represented by surrogate pairs (two char).

Specified by:

read in class Reader

Parameters:

cbuf - the destination buffer.

off - the offset at which to start storing characters.

len - the maximum number of characters to read

Returns:

the number of characters read, or -1 if there is no more byte remaining.

Throws:

IOException - if an I/O error occurs.

read

public void read(Appendable dest)
          throws IOException

Reads characters into the specified appendable. This method does not block.

Note: Characters between U+10000 and U+10FFFF are represented by surrogate pairs (two char).

Parameters:

dest - the destination buffer.

Throws:

IOException - if an I/O error occurs.

reset

public void reset()

Overrides:

reset in class Reader

setByteBuffer

public UTF8ByteBufferReader setByteBuffer(ByteBuffer byteBuffer)

Deprecated. Replaced by setInput(ByteBuffer)