public abstract class

FilterWriter

extends Writer
java.lang.Object
   ↳ java.io.Writer
     ↳ java.io.FilterWriter

Class Overview

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.

Summary

Fields
protected Writer out The underlying character-output stream.
[Expand]
Inherited Fields
From class java.io.Writer
Protected Constructors
FilterWriter(Writer out)
Create a new filtered writer.
Public Methods
void close()
Closes the stream, flushing it first.
void flush()
Flushes the stream.
void write(char[] cbuf, int off, int len)
Writes a portion of an array of characters.
void write(String str, int off, int len)
Writes a portion of a string.
void write(int c)
Writes a single character.
[Expand]
Inherited Methods
From class java.io.Writer
From class java.lang.Object
From interface java.io.Closeable
From interface java.io.Flushable
From interface java.lang.Appendable

Fields

protected Writer out

The underlying character-output stream.

Protected Constructors

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

Public Methods

public void close ()

Closes the stream, flushing it first. Once the stream has been closed, further write() or flush() invocations will cause an IOException to be thrown. Closing a previously closed stream has no effect.

Throws
IOException

public void flush ()

Flushes the stream.

Throws
IOException If an I/O error occurs

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

Writes 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
Throws
IOException If an I/O error occurs

public void write (String str, int off, int len)

Writes a portion of a string.

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

public void write (int c)

Writes a single character.

Parameters
c int specifying a character to be written
Throws
IOException If an I/O error occurs