java::io::FilterWriter Class Reference

Inheritance diagram for java::io::FilterWriter:

Inheritance graph
java::lang::Objectjava::lang::Interfacejava::io::Writer
[legend]
Collaboration diagram for java::io::FilterWriter:

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

List of all members.


Detailed Description

Abstract class for writing filtered character streams.

The abstract class FilterWriter itself provides default methods that pass all requests to the contained stream. Subclasses of FilterWriter 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

 FilterWriter (const Ref< Writer > &out=0)
 Create a new filtered writer.
virtual void write (jint b)
 Write a single character.
virtual void write (const Array< jchar > &b, jint off=0, jint len=-1)
 Write a portion of an array of characters.
virtual void write (const String &str, jint off=0, jint len=-1)
 Write a portion of a string.
virtual void flush ()
 Flush the stream.
virtual void close ()
 Close the stream.

Protected Attributes

Ref< Writerout
 The underlying character-output stream.

Constructor & Destructor Documentation

java::io::FilterWriter::FilterWriter ( const Ref< Writer > &  out = 0  ) 

Create a new filtered writer.

Parameters:
out a Writer object to provide the underlying stream.


Member Function Documentation

virtual void java::io::FilterWriter::write ( jint  b  )  [virtual]

Write a single character.

Exceptions:
IOException If an I/O error occurs

Implements java::io::Writer.

virtual void java::io::FilterWriter::write ( const Array< jchar > &  b,
jint  off = 0,
jint  len = -1 
) [virtual]

Write a portion of an array of characters.

Parameters:
cbuf Buffer of characters to be written
off Offset from which to start reading characters
len Number of characters to be written
Exceptions:
IOException If an I/O error occurs

Implements java::io::Writer.

virtual void java::io::FilterWriter::write ( const String str,
jint  off = 0,
jint  len = -1 
) [virtual]

Write a portion of a string.

Parameters:
str A String
off Offset from which to start writing characters
len Number of characters to write
Exceptions:
IOException If an I/O error occurs

Implements java::io::Writer.

virtual void java::io::FilterWriter::flush (  )  [virtual]

Flush the stream.

Exceptions:
IOException If an I/O error occurs

Reimplemented from java::io::Writer.

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

Close the stream.

Exceptions:
IOException If an I/O error occurs

Reimplemented from java::io::Writer.


Member Data Documentation

Ref<Writer> java::io::FilterWriter::out [protected]

The underlying character-output stream.


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