/*

 * Copyright 1996-2001 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;

/**

 * Convenience class for writing character files.  The constructors of this

 * class assume that the default character encoding and the default byte-buffer

 * size are acceptable.  To specify these values yourself, construct an

 * OutputStreamWriter on a FileOutputStream.

 *

 * <p>Whether or not a file is available or may be created depends upon the

 * underlying platform.  Some platforms, in particular, allow a file to be

 * opened for writing by only one <tt>FileWriter</tt> (or other file-writing

 * object) at a time.  In such situations the constructors in this class

 * will fail if the file involved is already open.

 *

 * <p><code>FileWriter</code> is meant for writing streams of characters.

 * For writing streams of raw bytes, consider using a

 * <code>FileOutputStream</code>.

 *

 * @see OutputStreamWriter

 * @see FileOutputStream

 *

 * @author      Mark Reinhold

 * @since       JDK1.1

 */

public class FileWriter extends OutputStreamWriter {

    /**

     * Constructs a FileWriter object given a file name.

     *

     * @param fileName  String The system-dependent filename.

     * @throws IOException  if the named file exists but is a directory rather

     *                  than a regular file, does not exist but cannot be

     *                  created, or cannot be opened for any other reason

     */

    public FileWriter(String fileName) throws IOException {

        super(new FileOutputStream(fileName));

    }

    /**

     * Constructs a FileWriter object given a file name with a boolean

     * indicating whether or not to append the data written.

     *

     * @param fileName  String The system-dependent filename.

     * @param append    boolean if <code>true</code>, then data will be written

     *                  to the end of the file rather than the beginning.

     * @throws IOException  if the named file exists but is a directory rather

     *                  than a regular file, does not exist but cannot be

     *                  created, or cannot be opened for any other reason

     */

    public FileWriter(String fileName, boolean append) throws IOException {

        super(new FileOutputStream(fileName, append));

    }

    /**

     * Constructs a FileWriter object given a File object.

     *

     * @param file  a File object to write to.

     * @throws IOException  if the file exists but is a directory rather than

     *                  a regular file, does not exist but cannot be created,

     *                  or cannot be opened for any other reason

     */

    public FileWriter(File file) throws IOException {

        super(new FileOutputStream(file));

    }

    /**

     * Constructs a FileWriter object given a File object. If the second

     * argument is <code>true</code>, then bytes will be written to the end

     * of the file rather than the beginning.

     *

     * @param file  a File object to write to

     * @param     append    if <code>true</code>, then bytes will be written

     *                      to the end of the file rather than the beginning

     * @throws IOException  if the file exists but is a directory rather than

     *                  a regular file, does not exist but cannot be created,

     *                  or cannot be opened for any other reason

     * @since 1.4

     */

    public FileWriter(File file, boolean append) throws IOException {

        super(new FileOutputStream(file, append));

    }

    /**

     * Constructs a FileWriter object associated with a file descriptor.

     *

     * @param fd  FileDescriptor object to write to.

     */

    public FileWriter(FileDescriptor fd) {

        super(new FileOutputStream(fd));

    }

}