Index (Frames) | Index (No Frames) | Package | Package Tree | Tree
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.

Authors:

Field Summary

java.io.Writerout

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

Constructor Summary

FilterWriter(java.io.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(java.lang.String str, int offset, int len)

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

Field Details

out

protected Writer out

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


Constructor Details

FilterWriter

protected FilterWriter(java.io.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:


Method Details

close

public void close()

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

Throws:


flush

public void flush()

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

Throws:


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:

Throws:


write

public void write(int b)

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

Parameters:

Throws:


write

public void write(java.lang.String str, int offset, int len)

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

Parameters:

Throws: