001/* FileWriter.java -- Convenience class for writing to files. 002 Copyright (C) 1998, 1999, 2001, 2003, 2004 Free Software Foundation, Inc. 003 004This file is part of GNU Classpath. 005 006GNU Classpath is free software; you can redistribute it and/or modify 007it under the terms of the GNU General Public License as published by 008the Free Software Foundation; either version 2, or (at your option) 009any later version. 010 011GNU Classpath is distributed in the hope that it will be useful, but 012WITHOUT ANY WARRANTY; without even the implied warranty of 013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014General Public License for more details. 015 016You should have received a copy of the GNU General Public License 017along with GNU Classpath; see the file COPYING. If not, write to the 018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 01902110-1301 USA. 020 021Linking this library statically or dynamically with other modules is 022making a combined work based on this library. Thus, the terms and 023conditions of the GNU General Public License cover the whole 024combination. 025 026As a special exception, the copyright holders of this library give you 027permission to link this library with independent modules to produce an 028executable, regardless of the license terms of these independent 029modules, and to copy and distribute the resulting executable under 030terms of your choice, provided that you also meet, for each linked 031independent module, the terms and conditions of the license of that 032module. An independent module is a module which is not derived from 033or based on this library. If you modify this library, you may extend 034this exception to your version of the library, but you are not 035obligated to do so. If you do not wish to do so, delete this 036exception statement from your version. */ 037 038 039package java.io; 040 041/* Written using "Java Class Libraries", 2nd edition, ISBN 0-201-31002-3 042 * "The Java Language Specification", ISBN 0-201-63451-1 043 * Status: Complete to version 1.1. 044 */ 045 046/** 047 * This is a convenience class for writing to files. It creates an 048 * <code>FileOutputStream</code> and initializes an 049 * <code>OutputStreamWriter</code> to write to it. 050 * 051 * @author Aaron M. Renn (arenn@urbanophile.com) 052 * @author Tom Tromey (tromey@cygnus.com) 053 */ 054public class FileWriter extends OutputStreamWriter 055{ 056 /** 057 * This method initializes a new <code>FileWriter</code> object to write 058 * to the specified <code>File</code> object. 059 * 060 * @param file The <code>File</code> object to write to. 061 * 062 * @throws SecurityException If writing to this file is forbidden by the 063 * <code>SecurityManager</code>. 064 * @throws IOException If any other error occurs 065 */ 066 public FileWriter(File file) throws SecurityException, IOException 067 { 068 super(new FileOutputStream(file)); 069 } 070 071 /** 072 * This method initializes a new <code>FileWriter</code> object to write 073 * to the specified <code>File</code> object. 074 * 075 * @param file The <code>File</code> object to write to. 076 * @param append <code>true</code> to start adding data at the end of the 077 * file, <code>false</code> otherwise. 078 * 079 * @throws SecurityException If writing to this file is forbidden by the 080 * <code>SecurityManager</code>. 081 * @throws IOException If any other error occurs 082 */ 083 public FileWriter(File file, boolean append) throws IOException 084 { 085 super(new FileOutputStream(file, append)); 086 } 087 088 /** 089 * This method initializes a new <code>FileWriter</code> object to write 090 * to the specified <code>FileDescriptor</code> object. 091 * 092 * @param fd The <code>FileDescriptor</code> object to write to 093 * 094 * @throws SecurityException If writing to this file is forbidden by the 095 * <code>SecurityManager</code>. 096 */ 097 public FileWriter(FileDescriptor fd) throws SecurityException 098 { 099 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}