001: /*
002: * Copyright 1996-2001 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: * Convenience class for writing character files. The constructors of this
030: * class assume that the default character encoding and the default byte-buffer
031: * size are acceptable. To specify these values yourself, construct an
032: * OutputStreamWriter on a FileOutputStream.
033: *
034: * <p>Whether or not a file is available or may be created depends upon the
035: * underlying platform. Some platforms, in particular, allow a file to be
036: * opened for writing by only one <tt>FileWriter</tt> (or other file-writing
037: * object) at a time. In such situations the constructors in this class
038: * will fail if the file involved is already open.
039: *
040: * <p><code>FileWriter</code> is meant for writing streams of characters.
041: * For writing streams of raw bytes, consider using a
042: * <code>FileOutputStream</code>.
043: *
044: * @see OutputStreamWriter
045: * @see FileOutputStream
046: *
047: * @version 1.25, 07/05/05
048: * @author Mark Reinhold
049: * @since JDK1.1
050: */
051:
052: public class FileWriter extends OutputStreamWriter {
053:
054: /**
055: * Constructs a FileWriter object given a file name.
056: *
057: * @param fileName String The system-dependent filename.
058: * @throws IOException if the named file exists but is a directory rather
059: * than a regular file, does not exist but cannot be
060: * created, or cannot be opened for any other reason
061: */
062: public FileWriter(String fileName) throws IOException {
063: super (new FileOutputStream(fileName));
064: }
065:
066: /**
067: * Constructs a FileWriter object given a file name with a boolean
068: * indicating whether or not to append the data written.
069: *
070: * @param fileName String The system-dependent filename.
071: * @param append boolean if <code>true</code>, then data will be written
072: * to the end of the file rather than the beginning.
073: * @throws IOException if the named file exists but is a directory rather
074: * than a regular file, does not exist but cannot be
075: * created, or cannot be opened for any other reason
076: */
077: public FileWriter(String fileName, boolean append)
078: throws IOException {
079: super (new FileOutputStream(fileName, append));
080: }
081:
082: /**
083: * Constructs a FileWriter object given a File object.
084: *
085: * @param file a File object to write to.
086: * @throws IOException if the file exists but is a directory rather than
087: * a regular file, does not exist but cannot be created,
088: * or cannot be opened for any other reason
089: */
090: public FileWriter(File file) throws IOException {
091: super (new FileOutputStream(file));
092: }
093:
094: /**
095: * Constructs a FileWriter object given a File object. If the second
096: * argument is <code>true</code>, then bytes will be written to the end
097: * of the file rather than the beginning.
098: *
099: * @param file a File object to write to
100: * @param append if <code>true</code>, then bytes will be written
101: * to the end of the file rather than the beginning
102: * @throws IOException if the file exists but is a directory rather than
103: * a regular file, does not exist but cannot be created,
104: * or cannot be opened for any other reason
105: * @since 1.4
106: */
107: public FileWriter(File file, boolean append) throws IOException {
108: super (new FileOutputStream(file, append));
109: }
110:
111: /**
112: * Constructs a FileWriter object associated with a file descriptor.
113: *
114: * @param fd FileDescriptor object to write to.
115: */
116: public FileWriter(FileDescriptor fd) {
117: super (new FileOutputStream(fd));
118: }
119:
120: }
| 