public abstract class

FilterWriter

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

Class Overview

Wraps an existing Writer and performs some transformation on the output data while it is being written. Transformations can be anything from a simple byte-wise filtering output data to an on-the-fly compression or decompression of the underlying writer. Writers that wrap another writer and provide some additional functionality on top of it usually inherit from this class.

See Also

Summary

Fields
protected Writer out The Writer being filtered.
[Expand]
Inherited Fields
From class java.io.Writer
Protected Constructors
FilterWriter(Writer out)
Constructs a new FilterWriter on the Writer out.
Public Methods
void close()
Closes this writer.
void flush()
Flushes this writer to ensure all pending data is sent out to the target writer.
void write(char[] buffer, int offset, int count)
Writes count characters from the char array buffer starting at position offset to the target writer.
void write(String str, int offset, int count)
Writes count characters from the string str starting at position index to this writer.
void write(int oneChar)
Writes the specified character oneChar to the target writer.
[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

Since: API Level 1

The Writer being filtered.

Protected Constructors

protected FilterWriter (Writer out)

Since: API Level 1

Constructs a new FilterWriter on the Writer out. All writes are now filtered through this writer.

Parameters
out the target Writer to filter writes on.

Public Methods

public void close ()

Since: API Level 1

Closes this writer. This implementation closes the target writer.

Throws
IOException if an error occurs attempting to close this writer.

public void flush ()

Since: API Level 1

Flushes this writer to ensure all pending data is sent out to the target writer. This implementation flushes the target writer.

Throws
IOException if an error occurs attempting to flush this writer.

public void write (char[] buffer, int offset, int count)

Since: API Level 1

Writes count characters from the char array buffer starting at position offset to the target writer.

Parameters
buffer the buffer to write.
offset the index of the first character in buffer to write.
count the number of characters in buffer to write.
Throws
IOException if an error occurs while writing to this writer.

public void write (String str, int offset, int count)

Since: API Level 1

Writes count characters from the string str starting at position index to this writer. This implementation writes str to the target writer.

Parameters
str the string to be written.
offset the index of the first character in str to write.
count the number of chars in str to write.
Throws
IOException if an error occurs while writing to this writer.

public void write (int oneChar)

Since: API Level 1

Writes the specified character oneChar to the target writer. Only the two least significant bytes of the integer oneChar are written.

Parameters
oneChar the char to write to the target writer.
Throws
IOException if an error occurs while writing to this writer.