1 /*

     2  * Copyright 1996-2001 Sun Microsystems, Inc.  All Rights Reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Sun designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Sun in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

    22  * CA 95054 USA or visit www.sun.com if you need additional information or

    23  * have any questions.

    24  */

    25 

    26 package java.io;

    27 

    28 

    29 /**

    30  * Convenience class for reading character files.  The constructors of this

    31  * class assume that the default character encoding and the default byte-buffer

    32  * size are appropriate.  To specify these values yourself, construct an

    33  * InputStreamReader on a FileInputStream.

    34  *

    35  * <p><code>FileReader</code> is meant for reading streams of characters.

    36  * For reading streams of raw bytes, consider using a

    37  * <code>FileInputStream</code>.

    38  *

    39  * @see InputStreamReader

    40  * @see FileInputStream

    41  *

    42  * @author      Mark Reinhold

    43  * @since       JDK1.1

    44  */

    45 public class FileReader extends InputStreamReader {

    46 

    47    /**

    48     * Creates a new <tt>FileReader</tt>, given the name of the

    49     * file to read from.

    50     *

    51     * @param fileName the name of the file to read from

    52     * @exception  FileNotFoundException  if the named file does not exist,

    53     *                   is a directory rather than a regular file,

    54     *                   or for some other reason cannot be opened for

    55     *                   reading.

    56     */

    57     public FileReader(String fileName) throws FileNotFoundException {

    58         super(new FileInputStream(fileName));

    59     }

    60 

    61    /**

    62     * Creates a new <tt>FileReader</tt>, given the <tt>File</tt>

    63     * to read from.

    64     *

    65     * @param file the <tt>File</tt> to read from

    66     * @exception  FileNotFoundException  if the file does not exist,

    67     *                   is a directory rather than a regular file,

    68     *                   or for some other reason cannot be opened for

    69     *                   reading.

    70     */

    71     public FileReader(File file) throws FileNotFoundException {

    72         super(new FileInputStream(file));

    73     }

    74 

    75    /**

    76     * Creates a new <tt>FileReader</tt>, given the

    77     * <tt>FileDescriptor</tt> to read from.

    78     *

    79     * @param fd the FileDescriptor to read from

    80     */

    81     public FileReader(FileDescriptor fd) {

    82         super(new FileInputStream(fd));

    83     }

    84 

    85 }