FilterWriter

public abstract class FilterWriter
extends Writer

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


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.

Inherited fields

protected Object lock

The object used to synchronize operations on this stream.

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(int c)

Writes a single character.

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

Writes a portion of a string.

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

Writes a portion of an array of characters.

Inherited methods

Writer append(char c)

Appends the specified character to this writer.

Writer append(CharSequence csq, int start, int end)

Appends a subsequence of the specified character sequence to this writer.

Writer append(CharSequence csq)

Appends the specified character sequence to this writer.

abstract void close()

Closes the stream, flushing it first.

abstract void flush()

Flushes the stream.

static Writer nullWriter()

Returns a new Writer which discards all characters.

void write(String str)

Writes a string.

void write(int c)

Writes a single character.

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

Writes a portion of a string.

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

Writes a portion of an array of characters.

void write(char[] cbuf)

Writes an array of characters.

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

abstract Appendable append(char c)

Appends the specified character to this Appendable.

abstract Appendable append(CharSequence csq, int start, int end)

Appends a subsequence of the specified character sequence to this Appendable.

abstract Appendable append(CharSequence csq)

Appends the specified character sequence to this Appendable.

abstract void close()

Closes this stream and releases any system resources associated with it.

abstract void flush()

Flushes this stream by writing any buffered output to the underlying stream.

abstract void close()

Closes this resource, relinquishing any underlying resources.

Fields

out

Added in API level 1
protected Writer out

The underlying character-output stream.

Protected constructors

FilterWriter

Added in API level 1
protected FilterWriter (Writer out)

Create a new filtered writer.

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

Throws
NullPointerException if out is null

Public methods

close

Added in API level 1
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

flush

Added in API level 1
public void flush ()

Flushes the stream.

Throws
IOException If an I/O error occurs

write

Added in API level 1
public void write (int c)

Writes a single character.

Parameters
c int: int specifying a character to be written

Throws
IOException If an I/O error occurs

write

Added in API level 1
public void write (String str, 
                int off, 
                int len)

Writes a portion of a string.

Parameters
str String: String to be written

off int: Offset from which to start reading characters

len int: Number of characters to be written

Throws
IndexOutOfBoundsException If the values of the off and len parameters cause the corresponding method of the underlying Writer to throw an IndexOutOfBoundsException
IOException If an I/O error occurs

write

Added in API level 1
public void write (char[] cbuf, 
                int off, 
                int len)

Writes a portion of an array of characters.

Parameters
cbuf char: Buffer of characters to be written

off int: Offset from which to start reading characters

len int: Number of characters to be written

Throws
IndexOutOfBoundsException If the values of the off and len parameters cause the corresponding method of the underlying Writer to throw an IndexOutOfBoundsException
IOException If an I/O error occurs