libjava/classpath/java/io/FileReader.java

   1 /* FileReader.java -- Convenience class for reading characters from a file
   2    Copyright (C) 1998, 2000, 2003 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 /**
  42  * This class provides a convenient way to set up a <code>Reader</code>
  43  * to read from a file.  It opens the specified file for reading and creates
  44  * the <code>InputStreamReader</code> to read from the
  45  * resulting <code>FileInputStream</code>.  This class can only be used
  46  * to read from files using the default character encoding.  Use
  47  * <code>InputStreamReader</code> directly to use a non-default encoding.
  48  *
  49  * @author Aaron M. Renn (arenn@urbanophile.com)
  50  */
  51 public class FileReader extends InputStreamReader
  52 {
  53   /**
  54    * This method initializes a <code>FileReader</code> instance to read from
  55    * the specified <code>File</code> object.
  56    *
  57    * @param file The <code>File</code> object representing the file to read from
  58    *
  59    * @exception FileNotFoundException If the file is not found or some other
  60    *            error occurs
  61    */
  62   public FileReader(File file) throws FileNotFoundException
  63   {
  64     super(new FileInputStream(file));
  65   }
  66
  67   /**
  68    * This method initializes a <code>FileReader</code> instance to read from
  69    * this specified <code>FileDescriptor</code> object.
  70    *
  71    * @param fd The <code>FileDescriptor</code> to read from.
  72    */
  73   public FileReader(FileDescriptor fd)
  74   {
  75     super(new FileInputStream(fd));
  76   }
  77
  78   /**
  79    * This method initializes a <code>FileReader</code> instance to read from
  80    * the specified named file.
  81    *
  82    * @param name The name of the file to read from
  83    *
  84    * @exception FileNotFoundException If the file is not found or some other
  85    *            error occurs
  86    */
  87   public FileReader(String name) throws FileNotFoundException
  88   {
  89     super(new FileInputStream(name));
  90   }
  91 } // class FileReader
  92