src/java.base/share/classes/java/io/FileReader.java
author erikj
Tue, 12 Sep 2017 19:03:39 +0200
changeset 47216 71c04702a3d5
parent 32033 jdk/src/java.base/share/classes/java/io/FileReader.java@bf24e33c7919
child 49254 422615764e12
permissions -rw-r--r--
8187443: Forest Consolidation: Move files to unified layout Reviewed-by: darcy, ihse
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     2
 * Copyright (c) 1996, 2001, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package java.io;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
 * Convenience class for reading character files.  The constructors of this
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 * class assume that the default character encoding and the default byte-buffer
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * size are appropriate.  To specify these values yourself, construct an
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * InputStreamReader on a FileInputStream.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 *
32033
bf24e33c7919 8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents: 25859
diff changeset
    35
 * <p>{@code FileReader} is meant for reading streams of characters.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * For reading streams of raw bytes, consider using a
32033
bf24e33c7919 8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents: 25859
diff changeset
    37
 * {@code FileInputStream}.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * @see InputStreamReader
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * @see FileInputStream
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 * @author      Mark Reinhold
24865
09b1d992ca72 8044740: Convert all JDK versions used in @since tag to 1.n[.n] in jdk repo
henryjen
parents: 5506
diff changeset
    43
 * @since       1.1
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
public class FileReader extends InputStreamReader {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
   /**
32033
bf24e33c7919 8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents: 25859
diff changeset
    48
    * Creates a new {@code FileReader}, given the name of the
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
    * file to read from.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
    *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
    * @param fileName the name of the file to read from
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
    * @exception  FileNotFoundException  if the named file does not exist,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
    *                   is a directory rather than a regular file,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
    *                   or for some other reason cannot be opened for
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
    *                   reading.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
    */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
    public FileReader(String fileName) throws FileNotFoundException {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
        super(new FileInputStream(fileName));
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
   /**
32033
bf24e33c7919 8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents: 25859
diff changeset
    62
    * Creates a new {@code FileReader}, given the {@code File}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
    * to read from.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
    *
32033
bf24e33c7919 8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents: 25859
diff changeset
    65
    * @param file the {@code File} to read from
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
    * @exception  FileNotFoundException  if the file does not exist,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
    *                   is a directory rather than a regular file,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
    *                   or for some other reason cannot be opened for
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
    *                   reading.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
    */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
    public FileReader(File file) throws FileNotFoundException {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
        super(new FileInputStream(file));
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
   /**
32033
bf24e33c7919 8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents: 25859
diff changeset
    76
    * Creates a new {@code FileReader}, given the
bf24e33c7919 8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents: 25859
diff changeset
    77
    * {@code FileDescriptor} to read from.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
    *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
    * @param fd the FileDescriptor to read from
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
    */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
    public FileReader(FileDescriptor fd) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
        super(new FileInputStream(fd));
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
}