lightbulb_outline Please take our October 2018 developer survey. Start survey

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

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