From be06f47bc163661477f50bf46e103314f1c24498 Mon Sep 17 00:00:00 2001 From: Michael Koch Date: Tue, 16 Nov 2004 11:30:14 +0000 Subject: BufferedReader.java, [...]: Fixed javadocs all over. 2004-11-16 Michael Koch * java/io/BufferedReader.java, java/io/FileInputStream.java, java/io/FileOutputStream.java, java/io/FileWriter.java, java/io/OutputStreamWriter.java, java/io/PipedInputStream.java, java/io/PipedOutputStream.java, java/io/PipedReader.java, java/io/PipedWriter.java, java/io/PrintStream.java, java/io/PushbackInputStream.java, java/io/RandomAccessFile.java, java/io/Reader.java, java/io/StreamTokenizer.java, java/io/StringReader.java, java/net/NetworkInterface.java, java/net/URLClassLoader.java, java/nio/ByteOrder.java, java/nio/channels/Channel.java: Fixed javadocs all over. From-SVN: r90727 --- libjava/java/io/FileWriter.java | 117 +++++++++++++++++++--------------------- 1 file changed, 55 insertions(+), 62 deletions(-) (limited to 'libjava/java/io/FileWriter.java') diff --git a/libjava/java/io/FileWriter.java b/libjava/java/io/FileWriter.java index 44db08c..fb48bba 100644 --- a/libjava/java/io/FileWriter.java +++ b/libjava/java/io/FileWriter.java @@ -1,5 +1,5 @@ /* FileWriter.java -- Convenience class for writing to files. - Copyright (C) 1998, 1999, 2001, 2003 Free Software Foundation, Inc. + Copyright (C) 1998, 1999, 2001, 2003, 2004 Free Software Foundation, Inc. This file is part of GNU Classpath. @@ -49,96 +49,89 @@ package java.io; * OutputStreamWriter to write to it. * * @author Aaron M. Renn (arenn@urbanophile.com) - * @author Tom Tromey + * @author Tom Tromey (tromey@cygnus.com) */ public class FileWriter extends OutputStreamWriter { - - /* - * Constructors - */ - /** - * This method initializes a new FileWriter object to write - * to the specified File object. - * - * @param file The File object to write to. - * - * @param SecurityException If writing to this file is forbidden by the - * SecurityManager. - * @param IOException If any other error occurs - */ + * This method initializes a new FileWriter object to write + * to the specified File object. + * + * @param file The File object to write to. + * + * @throws SecurityException If writing to this file is forbidden by the + * SecurityManager. + * @throws IOException If any other error occurs + */ public FileWriter(File file) throws SecurityException, IOException { super(new FileOutputStream(file)); } /** - * This method initializes a new FileWriter object to write - * to the specified File object. - * - * @param file The File object to write to. - * @param append true to start adding data at the end of the - * file, false otherwise. - * - * @param SecurityException If writing to this file is forbidden by the - * SecurityManager. - * @param IOException If any other error occurs - */ + * This method initializes a new FileWriter object to write + * to the specified File object. + * + * @param file The File object to write to. + * @param append true to start adding data at the end of the + * file, false otherwise. + * + * @throws SecurityException If writing to this file is forbidden by the + * SecurityManager. + * @throws IOException If any other error occurs + */ public FileWriter(File file, boolean append) throws IOException { super(new FileOutputStream(file, append)); } /** - * This method initializes a new FileWriter object to write - * to the specified FileDescriptor object. - * - * @param fd The FileDescriptor object to write to - * - * @param SecurityException If writing to this file is forbidden by the - * SecurityManager. - */ + * This method initializes a new FileWriter object to write + * to the specified FileDescriptor object. + * + * @param fd The FileDescriptor object to write to + * + * @throws SecurityException If writing to this file is forbidden by the + * SecurityManager. + */ public FileWriter(FileDescriptor fd) throws SecurityException { super(new FileOutputStream(fd)); } /** - * This method intializes a new FileWriter object to - * write to the - * specified named file. - * - * @param name The name of the file to write to - * - * @param SecurityException If writing to this file is forbidden by the - * SecurityManager. - * @param IOException If any other error occurs - */ + * This method intializes a new FileWriter object to + * write to the + * specified named file. + * + * @param name The name of the file to write to + * + * @throws SecurityException If writing to this file is forbidden by the + * SecurityManager. + * @throws IOException If any other error occurs + */ public FileWriter(String name) throws IOException { super(new FileOutputStream(name)); } /** - * This method intializes a new FileWriter object to - * write to the - * specified named file. This form of the constructor allows the caller - * to determin whether data should be written starting at the beginning or - * the end of the file. - * - * @param name The name of the file to write to - * @param append true to start adding data at the end of the - * file, false otherwise. - * - * @param SecurityException If writing to this file is forbidden by the - * SecurityManager. - * @param IOException If any other error occurs - */ + * This method intializes a new FileWriter object to + * write to the + * specified named file. This form of the constructor allows the caller + * to determin whether data should be written starting at the beginning or + * the end of the file. + * + * @param name The name of the file to write to + * @param append true to start adding data at the end of the + * file, false otherwise. + * + * @throws SecurityException If writing to this file is forbidden by the + * SecurityManager. + * @throws IOException If any other error occurs + */ public FileWriter(String name, boolean append) throws IOException { super(new FileOutputStream(name, append)); } - -} // class FileWriter - +} -- cgit v1.1