libjava/java/io/FileWriter.java

   1 /* FileWriter.java -- Convenience class for writing to files.
   2    Copyright (C) 1998, 1999, 2001 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
  59 /*
  60  * Constructors
  61  */
  62
  63 /**
  64   * This method initializes a new <code>FileWriter</code> object to write
  65   * to the specified <code>File</code> object.
  66   *
  67   * @param file The <code>File</code> object to write to.
  68   *
  69   * @param SecurityException If writing to this file is forbidden by the
  70   *                          <code>SecurityManager</code>.
  71   * @param IOException If any other error occurs
  72   */
  73 public
  74 FileWriter(File file) throws SecurityException, IOException
  75 {
  76   super(new FileOutputStream(file));
  77 }
  78
  79 /*************************************************************************/
  80
  81 /**
  82   * This method initializes a new <code>FileWriter</code> object to write
  83   * to the specified <code>FileDescriptor</code> object.
  84   *
  85   * @param fd The <code>FileDescriptor</code> object to write to
  86   *
  87   * @param SecurityException If writing to this file is forbidden by the
  88   *                          <code>SecurityManager</code>.
  89   */
  90 public
  91 FileWriter(FileDescriptor fd) throws SecurityException
  92 {
  93   super(new FileOutputStream(fd));
  94 }
  95
  96 /*************************************************************************/
  97
  98 /**
  99   * This method intializes a new <code>FileWriter</code> object to write to the
 100   * specified named file.
 101   *
 102   * @param name The name of the file to write to
 103   *
 104   * @param SecurityException If writing to this file is forbidden by the
 105   *                          <code>SecurityManager</code>.
 106   * @param IOException If any other error occurs
 107   */
 108 public
 109 FileWriter(String name) throws IOException
 110 {
 111   super(new FileOutputStream(name));
 112 }
 113
 114 /*************************************************************************/
 115
 116 /**
 117   * This method intializes a new <code>FileWriter</code> object to write to the
 118   * specified named file.  This form of the constructor allows the caller
 119   * to determin whether data should be written starting at the beginning or
 120   * the end of the file.
 121   *
 122   * @param name The name of the file to write to
 123   * @param append <code>true</code> to start adding data at the end of the
 124   *               file, <code>false</code> otherwise.
 125   *
 126   * @param SecurityException If writing to this file is forbidden by the
 127   *                          <code>SecurityManager</code>.
 128   * @param IOException If any other error occurs
 129   */
 130 public
 131 FileWriter(String name, boolean append) throws IOException
 132 {
 133   super(new FileOutputStream(name, append));
 134 }
 135
 136 } // class FileWriter
 137