java::io::FilterReader Class Reference

Inheritance diagram for java::io::FilterReader:

Inheritance graph
java::lang::Objectjava::lang::Interfacejava::io::Reader
[legend]
Collaboration diagram for java::io::FilterReader:

Collaboration graph
java::lang::Objectjava::lang::Interfacejava::io::Reader
[legend]

List of all members.


Detailed Description

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.

Version:
1.13, 01/12/03
Author:
Mark Reinhold
Since:
JDK1.1

Public Member Functions

 FilterReader (const Ref< Reader > &in=0)
 Create a new filtered reader.
virtual jint read ()
 Read a single character.
virtual jint read (Array< jchar > &b, jint ofs=0, jint len=-1)
 Read characters into a portion of an array.
virtual jlong skip (jlong n)
 Skip characters.
virtual jboolean ready ()
 Tell whether this stream is ready to be read.
virtual void close ()
 Close the stream.
virtual void mark (jint readlimit=0)
 Mark the present position in the stream.
virtual void reset ()
 Reset the stream.
virtual jboolean markSupported ()
 Tell whether this stream supports the mark() operation.

Protected Attributes

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

Constructor & Destructor Documentation

java::io::FilterReader::FilterReader ( const Ref< Reader > &  in = 0  ) 

Create a new filtered reader.

Parameters:
in a Reader object providing the underlying stream.


Member Function Documentation

virtual jint java::io::FilterReader::read (  )  [virtual]

Read a single character.

Exceptions:
IOException If an I/O error occurs

Implements java::io::Reader.

virtual jint java::io::FilterReader::read ( Array< jchar > &  b,
jint  ofs = 0,
jint  len = -1 
) [virtual]

Read characters into a portion of an array.

Exceptions:
IOException If an I/O error occurs

Implements java::io::Reader.

virtual jlong java::io::FilterReader::skip ( jlong  n  )  [virtual]

Skip characters.

Exceptions:
IOException If an I/O error occurs

Implements java::io::Reader.

virtual jboolean java::io::FilterReader::ready (  )  [virtual]

Tell whether this stream is ready to be read.

Exceptions:
IOException If an I/O error occurs

Reimplemented from java::io::Reader.

virtual void java::io::FilterReader::close (  )  [virtual]

Close the stream.

Exceptions:
IOException If an I/O error occurs

Reimplemented from java::io::Reader.

virtual void java::io::FilterReader::mark ( jint  readlimit = 0  )  [virtual]

Mark the present position in the stream.

Exceptions:
IOException If an I/O error occurs

Reimplemented from java::io::Reader.

virtual void java::io::FilterReader::reset (  )  [virtual]

Reset the stream.

Exceptions:
IOException If an I/O error occurs

Reimplemented from java::io::Reader.

virtual jboolean java::io::FilterReader::markSupported (  )  [virtual]

Tell whether this stream supports the mark() operation.

Reimplemented from java::io::Reader.


Member Data Documentation

Ref<Reader> java::io::FilterReader::in [protected]

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


The documentation for this class was generated from the following file:
Generated on Fri May 16 11:56:31 2008 for CrossPlatformJavaLikeC++API by  doxygen 1.5.3