toolchain/gcc/libjava/java/io/FileWriter.java

   1 /* FileWriter.java -- Convenience class for writing to files.
   2    Copyright (C) 1998, 1999, 2001, 2003 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package java.io;
  40
  41 /* Written using "Java Class Libraries", 2nd edition, ISBN 0-201-31002-3
  42  * "The Java Language Specification", ISBN 0-201-63451-1
  43  * Status:  Complete to version 1.1.
  44  */
  45
  46 /**
  47   * This is a convenience class for writing to files.  It creates an
  48   * <code>FileOutputStream</code> and initializes an
  49   * <code>OutputStreamWriter</code> to write to it.
  50   *
  51   * @author Aaron M. Renn (arenn@urbanophile.com)
  52   * @author Tom Tromey <tromey@cygnus.com>
  53   */
  54 public class FileWriter extends OutputStreamWriter
  55 {
  56
  57   /*
  58    * Constructors
  59    */
  60
  61   /**
  62     * This method initializes a new <code>FileWriter</code> object to write
  63     * to the specified <code>File</code> object.
  64     *
  65     * @param file The <code>File</code> object to write to.
  66     *
  67     * @param SecurityException If writing to this file is forbidden by the
  68     *                          <code>SecurityManager</code>.
  69     * @param IOException If any other error occurs
  70     */
  71   public FileWriter(File file) throws SecurityException, IOException
  72   {
  73     super(new FileOutputStream(file));
  74   }
  75
  76   /**
  77     * This method initializes a new <code>FileWriter</code> object to write
  78     * to the specified <code>File</code> object.
  79     *
  80     * @param file The <code>File</code> object to write to.
  81     * @param append <code>true</code> to start adding data at the end of the
  82     *               file, <code>false</code> otherwise.
  83     *
  84     * @param SecurityException If writing to this file is forbidden by the
  85     *                          <code>SecurityManager</code>.
  86     * @param IOException If any other error occurs
  87     */
  88   public FileWriter(File file, boolean append) throws IOException
  89   {
  90     super(new FileOutputStream(file, append));
  91   }
  92
  93   /**
  94     * This method initializes a new <code>FileWriter</code> object to write
  95     * to the specified <code>FileDescriptor</code> object.
  96     *
  97     * @param fd The <code>FileDescriptor</code> object to write to
  98     *
  99     * @param SecurityException If writing to this file is forbidden by the
 100     *                          <code>SecurityManager</code>.
 101     */
 102   public FileWriter(FileDescriptor fd) throws SecurityException
 103   {
 104     super(new FileOutputStream(fd));
 105   }
 106
 107   /**
 108     * This method intializes a new <code>FileWriter</code> object to
 109     * write to the
 110     * specified named file.
 111     *
 112     * @param name The name of the file to write to
 113     *
 114     * @param SecurityException If writing to this file is forbidden by the
 115     *                          <code>SecurityManager</code>.
 116     * @param IOException If any other error occurs
 117     */
 118   public FileWriter(String name) throws IOException
 119   {
 120     super(new FileOutputStream(name));
 121   }
 122
 123   /**
 124     * This method intializes a new <code>FileWriter</code> object to
 125     * write to the
 126     * specified named file.  This form of the constructor allows the caller
 127     * to determin whether data should be written starting at the beginning or
 128     * the end of the file.
 129     *
 130     * @param name The name of the file to write to
 131     * @param append <code>true</code> to start adding data at the end of the
 132     *               file, <code>false</code> otherwise.
 133     *
 134     * @param SecurityException If writing to this file is forbidden by the
 135     *                          <code>SecurityManager</code>.
 136     * @param IOException If any other error occurs
 137     */
 138   public FileWriter(String name, boolean append) throws IOException
 139   {
 140     super(new FileOutputStream(name, append));
 141   }
 142
 143 } // class FileWriter
 144