This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 

java.io
class FilterReader

java.lang.Object extended by java.io.Reader extended by java.io.FilterReader
All Implemented Interfaces:
Closeable, 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.

See Also (auto-generated):

BufferedReader

File

Reader

Field Summary
protected Reader in
          The underlying character-input stream.
 
Fields inherited from class java.io.Reader
lock
 
Constructor Summary
protected
FilterReader(Reader in)

          Creates a new filtered reader.
 
Method Summary
 void
close()

          Closes the stream and releases any system resources associated with it.
 void
mark(int readAheadLimit)

          Marks the present position in the stream.
 boolean
markSupported()

          Tells whether this stream supports the mark() operation.
 int
read()

          Reads a single character.
 int
read(char[] cbuf, int off, int len)

          Reads characters into a portion of an array.
 boolean
ready()

          Tells whether this stream is ready to be read.
 void
reset()

          Resets the stream.
 long
skip(long n)

          Skips characters.
 
Methods inherited from class java.io.Reader
close, mark, markSupported, read, read, read, read, ready, reset, skip
 
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.
Constructor Detail

FilterReader

protected FilterReader(Reader in)
Creates a new filtered reader.

Parameters:
in - a Reader object providing the underlying stream.
Method Detail

close

public void close()
           throws IOException
Overrides:
close in class Reader
Throws:
IOException

mark

public void mark(int readAheadLimit)
          throws IOException
Marks the present position in the stream.

Overrides:
mark in class Reader
Parameters:
readAheadLimit
Throws:
IOException - If an I/O error occurs

markSupported

public boolean markSupported()
Tells whether this stream supports the mark() operation.

Overrides:
markSupported in class Reader

read

public int read()
         throws IOException
Reads a single character.

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

read

public int read(char[] cbuf,
                int off,
                int len)
         throws IOException
Reads characters into a portion of an array.

Overrides:
read in class Reader
Parameters:
cbuf
off
len
Throws:
IOException - If an I/O error occurs

ready

public boolean ready()
              throws IOException
Tells whether this stream is ready to be read.

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

reset

public void reset()
           throws IOException
Resets the stream.

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

skip

public long skip(long n)
          throws IOException
Skips characters.

Overrides:
skip in class Reader
Parameters:
n
Throws:
IOException - If an I/O error occurs
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 
This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.