Source for java.io.FileWriter

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