/*

 * Copyright 1996-2005 Sun Microsystems, Inc.  All Rights Reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the LICENSE file that accompanied this code.

 *

 * This code 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

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

package java.io;

/**

 * Abstract class for writing filtered character streams.

 * The abstract class <code>FilterWriter</code> itself

 * provides default methods that pass all requests to the

 * contained stream. Subclasses of <code>FilterWriter</code>

 * should override some of these methods and may also

 * provide additional methods and fields.

 *

 * @author      Mark Reinhold

 * @since       JDK1.1

 */

public abstract class FilterWriter extends Writer {

    /**

     * The underlying character-output stream.

     */

    protected Writer out;

    /**

     * Create a new filtered writer.

     *

     * @param out  a Writer object to provide the underlying stream.

     * @throws NullPointerException if <code>out</code> is <code>null</code>

     */

    protected FilterWriter(Writer out) {

        super(out);

        this.out = out;

    }

    /**

     * Writes a single character.

     *

     * @exception  IOException  If an I/O error occurs

     */

    public void write(int c) throws IOException {

        out.write(c);

    }

    /**

     * Writes a portion of an array of characters.

     *

     * @param  cbuf  Buffer of characters to be written

     * @param  off   Offset from which to start reading characters

     * @param  len   Number of characters to be written

     *

     * @exception  IOException  If an I/O error occurs

     */

    public void write(char cbuf[], int off, int len) throws IOException {

        out.write(cbuf, off, len);

    }

    /**

     * Writes a portion of a string.

     *

     * @param  str  String to be written

     * @param  off  Offset from which to start reading characters

     * @param  len  Number of characters to be written

     *

     * @exception  IOException  If an I/O error occurs

     */

    public void write(String str, int off, int len) throws IOException {

        out.write(str, off, len);

    }

    /**

     * Flushes the stream.

     *

     * @exception  IOException  If an I/O error occurs

     */

    public void flush() throws IOException {

        out.flush();

    }

    public void close() throws IOException {

        out.close();

    }

}