java.io: abstract public class: FilterReader

java.io
abstract public class: FilterReader [javadoc | source]

java.lang.Object
   java.io.Reader
      java.io.FilterReader

All Implemented Interfaces:
Closeable, Readable

Direct Known Subclasses:
PushbackReader

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.

author: Mark - Reinhold

since: JDK1.1 -

Field Summary
protected Reader	in	The underlying character-input stream.

Fields inherited from java.io.Reader:
lock

Constructor:

Constructor:
protected FilterReader(Reader in) { super(in); this.in = in; } Creates a new filtered reader. Parameters: `in` - a Reader object providing the underlying stream. Throws: `NullPointerException` - if `in` is `null`

 protected FilterReader(Reader in) {
        super(in);
        this.in = in;
}

Creates a new filtered reader.

Parameters:

in - a Reader object providing the underlying stream.

Throws:

NullPointerException - if in is null

Method from java.io.FilterReader Summary:
close, mark, markSupported, read, read, ready, reset, skip

Methods from java.io.Reader:
close, mark, markSupported, read, read, read, read, ready, reset, skip

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from java.io.FilterReader Detail:
public void close() throws IOException { in.close(); }
public void mark(int readAheadLimit) throws IOException { in.mark(readAheadLimit); } Marks the present position in the stream.
public boolean markSupported() { return in.markSupported(); } Tells whether this stream supports the mark() operation.
public int read() throws IOException { return in.read(); } Reads a single character.
public int read(char[] cbuf, int off, int len) throws IOException { return in.read(cbuf, off, len); } Reads characters into a portion of an array.
public boolean ready() throws IOException { return in.ready(); } Tells whether this stream is ready to be read.
public void reset() throws IOException { in.reset(); } Resets the stream.
public long skip(long n) throws IOException { return in.skip(n); } Skips characters.

Method from java.io.FilterReader Detail:

 public  void close() throws IOException {
        in.close();
}

 public  void mark(int readAheadLimit) throws IOException {
        in.mark(readAheadLimit);
}

Marks the present position in the stream.

 public boolean markSupported() {
        return in.markSupported();
}

Tells whether this stream supports the mark() operation.

 public int read() throws IOException {
        return in.read();
}

Reads a single character.

 public int read(char[] cbuf,
    int off,
    int len) throws IOException {
        return in.read(cbuf, off, len);
}

Reads characters into a portion of an array.

 public boolean ready() throws IOException {
        return in.ready();
}

Tells whether this stream is ready to be read.

 public  void reset() throws IOException {
        in.reset();
}

Resets the stream.

 public long skip(long n) throws IOException {
        return in.skip(n);
}

Skips characters.