java.io

Class FilterWriter

java.lang.Object

java.io.Writer

java.io.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.

Author:

Aaron M. Renn (arenn@urbanophile.com), Tom Tromey

Field Summary

Fields

Modifier and Type	Field and Description
protected Writer	out This is the subordinate Writer that this class redirects its method calls to.

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FilterWriter(Writer out) This method initializes an instance of FilterWriter to write to the specified subordinate Writer.

Method Summary

Modifier and Type	Method and Description
void	close() This method closes the underlying Writer.
void	flush() This method attempt to flush all buffered output to be written to the underlying output sink.
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.
void	write(int b) This method writes a single char of output to the underlying Writer.
void	write(String str, int offset, int len) This method writes len chars from the String starting at position offset.

Methods inherited from class java.io.Writer

write, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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()
           throws IOException

This method closes the underlying Writer. Any further attempts to write to this stream may throw an exception.

Specified by:

close in class Writer

Throws:

IOException - If an error occurs

flush

public void flush()
           throws IOException

This method attempt to flush all buffered output to be written to the underlying output sink.

Specified by:

flush in class Writer

Throws:

IOException - If an error occurs

write

public void write(int b)
           throws IOException

This method writes a single char of output to the underlying Writer.

Overrides:

write in class 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)
           throws IOException

This method writes len chars from the array buf starting at index offset to the underlying Writer.

Specified by:

write in class 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)
           throws IOException

This method writes len chars from the String starting at position offset.

Overrides:

write in class Writer

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