API java : FilterWriter

java.io
Class FilterWriter

java.lang.Object
  java.io.Writer
      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.

Since:

JDK1.1

Field Summary
protected  Writer	out           The underlying character-output stream.

 

Fields inherited from class java.io.Writer
lock

 

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

 

Method Summary
void	close()           Close the stream.
void	flush()           Flush the stream.
void	write(char[] cbuf, int off, int len)           Write a portion of an array of characters.
void	write(int c)           Write a single character.
void	write(String str, int off, int len)           Write a portion of a string.

 

Methods inherited from class java.io.Writer
append, append, append, 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.

FilterWriter

protected FilterWriter(Writer out)

Create a new filtered writer.

Parameters:

out - a Writer object to provide the underlying stream.

Throws:

NullPointerException - if out is null

write

public void write(int c)
           throws IOException

Write a single character.

Overrides:

write in class Writer

Parameters:

c - int specifying a character to be written.

Throws:

IOException - If an I/O error occurs

write

public void write(char[] cbuf,
                  int off,
                  int len)
           throws IOException

Write a portion of an array of characters.

Specified by:

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(String str,
                  int off,
                  int len)
           throws IOException

Write 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

flush

public void flush()
           throws IOException

Flush the stream.

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

Throws:

IOException - If an I/O error occurs

close

public void close()
           throws IOException

Close the stream.

Specified by:

close in interface Closeable

Specified by:

close in class Writer

Throws:

IOException - If an I/O error occurs