From 67f279dfebbb2690ebf57246e27794e6b18fdae9 Mon Sep 17 00:00:00 2001
From: Bryce McKinlay <bryce@albatross.co.nz>
Date: Mon, 30 Oct 2000 09:20:47 +0000
Subject: Reader.java: Merge docs from classpath.

	* java/io/Reader.java: Merge docs from classpath.
	(skip): Synchronize on `lock'.
	* java/io/FileReader.java: Import correct implementation from
	classpath.
	* java/io/StringReader.java: Merge docs from classpath.
	(ready): Throw IOException if stream is closed.

From-SVN: r37143
---
 libjava/java/io/FileReader.java | 81 ++++++++++++++++++++++++++++++++---------
 1 file changed, 64 insertions(+), 17 deletions(-)

(limited to 'libjava/java/io/FileReader.java')

diff --git a/libjava/java/io/FileReader.java b/libjava/java/io/FileReader.java
index c82ce5b..0dbcd0e 100644
--- a/libjava/java/io/FileReader.java
+++ b/libjava/java/io/FileReader.java
@@ -1,35 +1,82 @@
-/* Copyright (C) 1998, 1999  Free Software Foundation
+/* FileReader.java -- Convenience class for reading characters from a file
+   Copyright (C) 1998, 2000 Free Software Foundation, Inc.
 
-   This file is part of libgcj.
+This file is part of GNU Classpath.
 
-This software is copyrighted work licensed under the terms of the
-Libgcj License.  Please consult the file "LIBGCJ_LICENSE" for
-details.  */
+GNU Classpath is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2, or (at your option)
+any later version.
  
+GNU Classpath is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with GNU Classpath; see the file COPYING.  If not, write to the
+Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+02111-1307 USA.
+
+As a special exception, if you link this library with other files to
+produce an executable, this library does not by itself cause the
+resulting executable to be covered by the GNU General Public License.
+This exception does not however invalidate any other reasons why the
+executable file might be covered by the GNU General Public License. */
+
+
 package java.io;
 
 /**
- * @author Per Bothner <bothner@cygnus.com>
- * @date April 22, 1998.  
- */
-/* Written using "Java Class Libraries", 2nd edition.
- * Status:  Believed complete and correct.
+ * This class provides a convenient way to set up a <code>Reader</code>
+ * to read from a file.  It opens the specified file for reading and creates
+ * the <code>InputStreamReader</code> to read from the 
+ * resulting <code>FileInputStream</code>.  This class can only be used
+ * to read from files using the default character encoding.  Use
+ * <code>InputStreamReader</code> directly to use a non-default encoding.
+ *
+ * @version 0.0
+ *
+ * @author Aaron M. Renn (arenn@urbanophile.com)
  */
-
 public class FileReader extends InputStreamReader
 {
-  public FileReader(String filename) throws IOException
-  {
-    super(new FileInputStream(filename));
-  }
-
-  public FileReader(File file) throws IOException
+  /**
+   * This method initializes a <code>FileReader</code> instance to read from
+   * the specified <code>File</code> object.
+   *
+   * @param file The <code>File</code> object representing the file to read from
+   *
+   * @exception FileNotFoundException If the file is not found or some other 
+   *            error occurs
+   */
+  public FileReader(File file) throws FileNotFoundException
   {
     super(new FileInputStream(file));
   }
 
+  /**
+   * This method initializes a <code>FileReader</code> instance to read from
+   * this specified <code>FileDescriptor</code> object.
+   *
+   * @param fd The <code>FileDescriptor</code> to read from.
+   */
   public FileReader(FileDescriptor fd)
   {
     super(new FileInputStream(fd));
   }
+
+  /**
+   * This method initializes a <code>FileReader</code> instance to read from
+   * the specified named file.
+   *
+   * @param name The name of the file to read from
+   *
+   * @exception FileNotFoundException If the file is not found or some other 
+   *            error occurs
+   */
+  public FileReader(String name) throws FileNotFoundException
+  {
+    super(new FileInputStream(name));
+  }
 }
-- 
cgit v1.1