001/* FileReader.java -- Convenience class for reading characters from a file
002   Copyright (C) 1998, 2000, 2003 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/**
042 * This class provides a convenient way to set up a <code>Reader</code>
043 * to read from a file.  It opens the specified file for reading and creates
044 * the <code>InputStreamReader</code> to read from the
045 * resulting <code>FileInputStream</code>.  This class can only be used
046 * to read from files using the default character encoding.  Use
047 * <code>InputStreamReader</code> directly to use a non-default encoding.
048 *
049 * @author Aaron M. Renn (arenn@urbanophile.com)
050 */
051public class FileReader extends InputStreamReader
052{
053  /**
054   * This method initializes a <code>FileReader</code> instance to read from
055   * the specified <code>File</code> object.
056   *
057   * @param file The <code>File</code> object representing the file to read from
058   *
059   * @exception FileNotFoundException If the file is not found or some other
060   *            error occurs
061   */
062  public FileReader(File file) throws FileNotFoundException
063  {
064    super(new FileInputStream(file));
065  }
066
067  /**
068   * This method initializes a <code>FileReader</code> instance to read from
069   * this specified <code>FileDescriptor</code> object.
070   *
071   * @param fd The <code>FileDescriptor</code> to read from.
072   */
073  public FileReader(FileDescriptor fd)
074  {
075    super(new FileInputStream(fd));
076  }
077
078  /**
079   * This method initializes a <code>FileReader</code> instance to read from
080   * the specified named file.
081   *
082   * @param name The name of the file to read from
083   *
084   * @exception FileNotFoundException If the file is not found or some other
085   *            error occurs
086   */
087  public FileReader(String name) throws FileNotFoundException
088  {
089    super(new FileInputStream(name));
090  }
091} // class FileReader