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.


java.io
class FilterWriter

java.lang.Object extended by java.io.Writer extended by java.io.FilterWriter
All Implemented Interfaces:
Closeable, Flushable, Appendable

public abstract class FilterWriter
extends Writer

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.

See Also (auto-generated):

BufferedReader

FileOutputStream

PrintWriter


Field Summary
protected Writer out
          The underlying character-output stream.
 
Fields inherited from class java.io.Writer
lock
 
Constructor Summary
protected

          Create a new filtered writer.
 
Method Summary
 void

          Closes the stream, flushing it first.
 void

          Flushes the stream.
 void
write(char[] cbuf, int off, int len)

          Writes a portion of an array of characters.
 void
write(int c)

          Writes a single character.
 void
write(String str, int off, int len)

          Writes a portion of a string.
 
Methods inherited from class java.io.Writer
append, append, append, close, flush, write, write, write, write, write
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

out

protected Writer out
The underlying character-output stream.
Constructor Detail

FilterWriter

protected FilterWriter(Writer out)
Create a new filtered writer.

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

close

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

flush

public void flush()
           throws IOException
Flushes the stream.

Overrides:
flush in class Writer
Throws:
IOException - If an I/O error occurs

write

public void write(char[] cbuf,
                  int off,
                  int len)
           throws IOException
Writes a portion of an array of characters.

Overrides:
write in class Writer
Parameters:
cbuf - Buffer of characters to be written
off - Offset from which to start reading characters
len - Number of characters to be written
Throws:
IOException - If an I/O error occurs

write

public void write(int c)
           throws IOException
Writes a single character.

Overrides:
write in class Writer
Parameters:
c
Throws:
IOException - If an I/O error occurs

write

public void write(String str,
                  int off,
                  int len)
           throws IOException
Writes a portion of a string.

Overrides:
write in class Writer
Parameters:
str - String to be written
off - Offset from which to start reading characters
len - Number of characters to be written
Throws:
IOException - If an I/O error occurs


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/.