org.ka2ddo.util

Class UTF8StreamReader

java.lang.Object

java.io.Reader

org.ka2ddo.util.UTF8StreamReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Readable

public class UTF8StreamReader
extends java.io.Reader

This class implements an optimized stream-to-reader conversion assuming only UTF-8.

Author:

Andrew Pavlin, KA2DDO

Field Summary

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Constructor and Description
UTF8StreamReader(java.io.InputStream in) Create a UTF8StreamReader wrapped around the specified InputStream.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the stream and releases any system resources associated with it.
int	read() Reads a single character.
int	read(char[] cbuf) Reads characters into an array.
int	read(char[] cbuf, int off, int len) Reads characters into a portion of an array.

Methods inherited from class java.io.Reader

mark, markSupported, read, ready, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

UTF8StreamReader

public UTF8StreamReader(java.io.InputStream in)

Create a UTF8StreamReader wrapped around the specified InputStream.

Parameters:

in - InputStream to read and decode

Method Detail

read

public int read()
         throws java.io.IOException

Reads a single character. This method will block until a character is available, an I/O error occurs, or the end of the stream is reached.

Overrides:

read in class java.io.Reader

Returns:

The character read, as an integer in the range 0 to 65535 (0x00-0xffff), or -1 if the end of the stream has been reached

Throws:

java.io.IOException - If an I/O error occurs

read

public int read(char[] cbuf)
         throws java.io.IOException

Reads characters into an array. This method will block until some input is available, an I/O error occurs, or the end of the stream is reached.

Overrides:

read in class java.io.Reader

Parameters:

cbuf - Destination buffer

Returns:

The number of characters read, or -1 if the end of the stream has been reached

Throws:

java.io.IOException - If an I/O error occurs

read

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

Reads characters into a portion of an array. This method will block until some input is available, an I/O error occurs, or the end of the stream is reached.

Specified by:

read in class java.io.Reader

Parameters:

cbuf - Destination buffer

off - Offset at which to start storing characters

len - Maximum number of characters to read

Returns:

The number of characters read, or -1 if the end of the stream has been reached

Throws:

java.io.IOException - If an I/O error occurs

close

public void close()
           throws java.io.IOException

Closes the stream and releases any system resources associated with it. Once the stream has been closed, further read(), ready(), mark(), reset(), or skip() invocations will throw an IOException. Closing a previously closed stream has no effect.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class java.io.Reader

Throws:

java.io.IOException - If an I/O error occurs