class:FilterReader [NONE]

All Implemented Interfaces:: Closeable, AutoCloseable, Readable

Direct Known Subclasses:: PushbackReader

public abstract class FilterReader
extends Reader

Abstract class for reading filtered character streams. The abstract class FilterReader itself provides default methods that pass all requests to the contained stream. Subclasses of FilterReader should override some of these methods and may also provide additional methods and fields.

Since:: 1.1

field:in [NONE]

in

protected Reader in

The underlying character-input stream.

constructor:FilterReader(java.io.Reader) [NONE]

FilterReader

protected FilterReader?(Reader in)

Creates a new filtered reader.

Parameters:

in - a Reader object providing the underlying stream.

Throws:

NullPointerException - if in is null

method:read() [NONE]

read

public int read() throws IOException

Reads a single character.

Overrides:: read in class 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:: IOException - If an I/O error occurs

method:read(char[],int,int) [NONE]

read

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

Reads characters into a portion of an array.

Specified by:: read in class 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:: IOException - If an I/O error occurs; IndexOutOfBoundsException - If off is negative, or len is negative, or len is greater than cbuf.length - off

method:skip(long) [NONE]

skip

public long skip?(long n) throws IOException

Skips characters.

Overrides:: skip in class Reader
Parameters:: n - The number of characters to skip
Returns:: The number of characters actually skipped
Throws:: IOException - If an I/O error occurs

method:ready() [NONE]

ready

public boolean ready() throws IOException

Tells whether this stream is ready to be read.

Overrides:: ready in class Reader
Returns:: True if the next read() is guaranteed not to block for input, false otherwise. Note that returning false does not guarantee that the next read will block.
Throws:: IOException - If an I/O error occurs

method:markSupported() [NONE]

markSupported

public boolean markSupported()

Tells whether this stream supports the mark() operation.

Overrides:: markSupported in class Reader
Returns:: true if and only if this stream supports the mark operation.

method:mark(int) [NONE]

mark

public void mark?(int readAheadLimit) throws IOException

Marks the present position in the stream.

Overrides:: mark in class Reader
Parameters:: readAheadLimit - Limit on the number of characters that may be read while still preserving the mark. After reading this many characters, attempting to reset the stream may fail.
Throws:: IOException - If an I/O error occurs

method:reset() [NONE]

reset

public void reset() throws IOException

Resets the stream.

Overrides:: reset in class Reader
Throws:: IOException - If an I/O error occurs

method:close() [NONE]

close

public void close() throws IOException

Description copied from class: Reader

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 AutoCloseable
Specified by:: close in interface Closeable
Specified by:: close in class Reader
Throws:: IOException - If an I/O error occurs