java.io

Class FilterWriter

public abstract class FilterWriter extends Writer

This class is the common superclass of output character stream classes that filter the output they write. These classes typically transform the data in some way prior to writing it out to another underlying Writer. This class simply overrides all the methods in Writer to redirect them to the underlying stream. Subclasses provide actual filtering.
Field Summary
protected Writerout
This is the subordinate Writer that this class redirects its method calls to.
Constructor Summary
protected FilterWriter(Writer out)
This method initializes an instance of FilterWriter to write to the specified subordinate Writer.
Method Summary
voidclose()
This method closes the underlying Writer.
voidflush()
This method attempt to flush all buffered output to be written to the underlying output sink.
voidwrite(int b)
This method writes a single char of output to the underlying Writer.
voidwrite(char[] buf, int offset, int len)
This method writes len chars from the array buf starting at index offset to the underlying Writer.
voidwrite(String str, int offset, int len)
This method writes len chars from the String starting at position offset.

Field Detail

out

protected Writer out
This is the subordinate Writer that this class redirects its method calls to.

Constructor Detail

FilterWriter

protected FilterWriter(Writer out)
This method initializes an instance of FilterWriter to write to the specified subordinate Writer. The given Writer will be used as lock for the newly created FilterWriter.

Parameters: out The Writer to write to

Method Detail

close

public void close()
This method closes the underlying Writer. Any further attempts to write to this stream may throw an exception.

Throws: IOException If an error occurs

flush

public void flush()
This method attempt to flush all buffered output to be written to the underlying output sink.

Throws: IOException If an error occurs

write

public void write(int b)
This method writes a single char of output to the underlying Writer.

Parameters: b The char to write, passed as an int.

Throws: IOException If an error occurs

write

public void write(char[] buf, int offset, int len)
This method writes len chars from the array buf starting at index offset to the underlying Writer.

Parameters: buf The char array to write chars from offset The index into the array to start writing chars from len The number of chars to write

Throws: IOException If an error occurs

write

public void write(String str, int offset, int len)
This method writes len chars from the String starting at position offset.

Parameters: str The String that is to be written offset The character offset into the String to start writing from len The number of chars to write

Throws: IOException If an error occurs