001 /*
002 * Copyright 1996-2005 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package java.io;
027
028 /**
029 * Abstract class for writing filtered character streams.
030 * The abstract class <code>FilterWriter</code> itself
031 * provides default methods that pass all requests to the
032 * contained stream. Subclasses of <code>FilterWriter</code>
033 * should override some of these methods and may also
034 * provide additional methods and fields.
035 *
036 * @version 1.24, 07/05/05
037 * @author Mark Reinhold
038 * @since JDK1.1
039 */
040
041 public abstract class FilterWriter extends Writer {
042
043 /**
044 * The underlying character-output stream.
045 */
046 protected Writer out;
047
048 /**
049 * Create a new filtered writer.
050 *
051 * @param out a Writer object to provide the underlying stream.
052 * @throws NullPointerException if <code>out</code> is <code>null</code>
053 */
054 protected FilterWriter(Writer out) {
055 super (out);
056 this .out = out;
057 }
058
059 /**
060 * Writes a single character.
061 *
062 * @exception IOException If an I/O error occurs
063 */
064 public void write(int c) throws IOException {
065 out.write(c);
066 }
067
068 /**
069 * Writes a portion of an array of characters.
070 *
071 * @param cbuf Buffer of characters to be written
072 * @param off Offset from which to start reading characters
073 * @param len Number of characters to be written
074 *
075 * @exception IOException If an I/O error occurs
076 */
077 public void write(char cbuf[], int off, int len) throws IOException {
078 out.write(cbuf, off, len);
079 }
080
081 /**
082 * Writes a portion of a string.
083 *
084 * @param str String to be written
085 * @param off Offset from which to start reading characters
086 * @param len Number of characters to be written
087 *
088 * @exception IOException If an I/O error occurs
089 */
090 public void write(String str, int off, int len) throws IOException {
091 out.write(str, off, len);
092 }
093
094 /**
095 * Flushes the stream.
096 *
097 * @exception IOException If an I/O error occurs
098 */
099 public void flush() throws IOException {
100 out.flush();
101 }
102
103 public void close() throws IOException {
104 out.close();
105 }
106
107 }
|