java.io
Class FilterReader

java.lang.Object
  |
  +--java.io.Reader
        |
        +--java.io.FilterReader

Direct Known Subclasses:

PushbackReader

public abstract class FilterReader

extends Reader

Untamed: 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:

JDK1.1

Version:

1.13, 01/12/03

Author:

Mark Reinhold

Field Summary

protected Reader

in The underlying character-input stream, or null if the stream has been closed.

Fields inherited from class java.io.Reader

lock

Constructor Summary

protected

FilterReader(Reader in) Create a new filtered reader.

Method Summary

void	close() Enabled: Close the stream.
void	mark(int readAheadLimit) Enabled: Mark the present position in the stream.
boolean	markSupported() Enabled: Tell whether this stream supports the mark() operation.
int	read() Enabled: Read a single character.
int	read(char[] cbuf, int off, int len) Enabled: Read characters into a portion of an array.
boolean	ready() Enabled: Tell whether this stream is ready to be read.
void	reset() Enabled: Reset the stream.
long	skip(long n) Enabled: Skip characters.

Methods inherited from class java.io.Reader

getText, getTwine, iterate, iterate, read, readChar, readString

Methods inherited from class java.lang.Object

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

Field Detail

in

protected Reader in

The underlying character-input stream, or null if the stream has been closed.

Constructor Detail

FilterReader

protected FilterReader(Reader in)

Create a new filtered reader.

Parameters:

in - a Reader object providing the underlying stream.

Method Detail

read

public int read()
         throws IOException

Enabled: Read 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

IOException

read

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

Enabled: Read 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

IOException

skip

public long skip(long n)
          throws IOException

Enabled: Skip characters.

Overrides:

skip in class Reader

Parameters:

n - The number of characters to skip

Returns:

The number of characters actually skipped

IOException

ready

public boolean ready()
              throws IOException

Enabled: Tell 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.

IOException

markSupported

public boolean markSupported()

Enabled: Tell whether this stream supports the mark() operation.

Overrides:

markSupported in class Reader

Returns:

true if and only if this stream supports the mark operation.

mark

public void mark(int readAheadLimit)
          throws IOException

Enabled: Mark 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.

IOException

reset

public void reset()
           throws IOException

Enabled: Reset the stream.

Overrides:

reset in class Reader

IOException

close

public void close()
           throws IOException

Enabled: Close the stream.

Specified by:

close in class Reader

IOException