jsimple.io

Class Reader

java.lang.Object

jsimple.lang.AutoCloseable

jsimple.io.Reader

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

BufferedReader, StringReader, Utf8InputStreamReader

public abstract class Reader
extends AutoCloseable

This class was based on, and modified from, the Apache Harmony java.io.Reader class. Unlike the Java Reader class, this doesn't do locking and doesn't throw any checked exceptions.

The base class for all readers. A reader is a means of reading data from a source in a character-wise manner.

This abstract class does not provide a fully working implementation, so it needs to be subclassed, and at least the read(char[], int, int) and AutoCloseable.close() methods needs to be overridden. Overriding some of the non-abstract methods is also often advised, since it might result in higher efficiency.

Constructor Summary

Constructors

Constructor and Description
Reader()

Method Summary

Modifier and Type	Method and Description
int	read() Reads a single character from this reader and returns it as an integer with the two higher-order bytes set to 0.
int	read(char[] buffer) Reads characters from this reader and stores them in the character array buf starting at offset 0.
abstract int	read(char[] buffer, int offset, int count) Reads at most count characters from this reader and stores them at offset in the character array buf.

Methods inherited from class jsimple.lang.AutoCloseable

close

Methods inherited from class java.lang.Object

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

Constructor Detail

Reader

public Reader()

Method Detail

read

public int read()

Reads a single character from this reader and returns it as an integer with the two higher-order bytes set to 0. Returns -1 if the end of the reader has been reached.

Returns:

the character read or -1 if the end of the reader has been reached

Throws:

IOException - if this reader is closed or some other I/O error occurs

read

public int read(char[] buffer)

Reads characters from this reader and stores them in the character array buf starting at offset 0. Returns the number of characters actually read or -1 if the end of the reader has been reached.

Parameters:

buffer - character array to store the characters read.

Returns:

the number of characters read or -1 if the end of the reader has been reached

Throws:

IOException - if this reader is closed or some other I/O error occurs

read

public abstract int read(char[] buffer,
                         int offset,
                         int count)

Reads at most count characters from this reader and stores them at offset in the character array buf. Returns the number of characters actually read or -1 if the end of the reader has been reached.

Parameters:

buffer - the character array to store the characters read

offset - the initial position in buffer to store the characters read from this reader

count - the maximum number of characters to read

Returns:

the number of characters read or -1 if the end of the reader has been reached

Throws:

IOException - if this reader is closed or some other I/O error occurs