java.io

Class FilterWriter

Implemented Interfaces:
Appendable, Closeable, Flushable

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

FilterWriter(Writer out)
This method initializes an instance of FilterWriter to write to the specified subordinate Writer.

Method Summary

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

append, append, append, close, flush, write, write, write, write, write

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

out

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

Constructor Details

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 Details

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 interface Closeable
Overrides:
close in interface 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 interface Flushable
Overrides:
flush in interface Writer
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.
Overrides:
write in interface 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(int b)
            throws IOException
This method writes a single char of output to the underlying Writer.
Overrides:
write in interface Writer
Parameters:
b - The char to write, passed as an int.
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 interface 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

FilterWriter.java -- Parent class for output streams that filter Copyright (C) 1998, 1999, 2001, 2003, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.