src/java.base/share/classes/java/io/FileReader.java
author bpb
Thu, 06 Jun 2019 08:11:25 -0700
changeset 55259 61fff1345ee6
parent 49254 422615764e12
child 58242 94bb65cb37d3
permissions -rw-r--r--
8219992: Correct the documentation of PrintWriter to refer System.lineSeparator Reviewed-by: darcy, lancea, rriggs
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
49254
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
     2
 * Copyright (c) 1996, 2018, 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
49254
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    28
import java.nio.charset.Charset;
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
/**
49254
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    31
 * Reads text from character files using a default buffer size. Decoding from bytes
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    32
 * to characters uses either a specified {@linkplain java.nio.charset.Charset charset}
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    33
 * or the platform's
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    34
 * {@linkplain java.nio.charset.Charset#defaultCharset() default charset}.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 *
49254
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    36
 * <p>
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    37
 * The {@code FileReader} is meant for reading streams of characters. For reading
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    38
 * streams of raw bytes, consider using a {@code FileInputStream}.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * @see InputStreamReader
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 * @see FileInputStream
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 * @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
    44
 * @since       1.1
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
public class FileReader extends InputStreamReader {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
   /**
49254
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    49
    * Creates a new {@code FileReader}, given the name of the file to read,
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    50
    * using the platform's
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    51
    * {@linkplain java.nio.charset.Charset#defaultCharset() default charset}.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
    *
49254
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    53
    * @param fileName the name of the file to read
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
    * @exception  FileNotFoundException  if the named file does not exist,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
    *                   is a directory rather than a regular file,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
    *                   or for some other reason cannot be opened for
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
    *                   reading.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
    */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
    public FileReader(String fileName) throws FileNotFoundException {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
        super(new FileInputStream(fileName));
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
   /**
49254
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    64
    * Creates a new {@code FileReader}, given the {@code File} to read,
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    65
    * using the platform's
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    66
    * {@linkplain java.nio.charset.Charset#defaultCharset() default charset}.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
    *
49254
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    68
    * @param file the {@code File} to read
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
    * @exception  FileNotFoundException  if the file does not exist,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
    *                   is a directory rather than a regular file,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
    *                   or for some other reason cannot be opened for
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
    *                   reading.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
    */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
    public FileReader(File file) throws FileNotFoundException {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
        super(new FileInputStream(file));
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
   /**
49254
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    79
    * Creates a new {@code FileReader}, given the {@code FileDescriptor} to read,
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    80
    * using the platform's
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    81
    * {@linkplain java.nio.charset.Charset#defaultCharset() default charset}.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
    *
49254
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    83
    * @param fd the {@code FileDescriptor} to read
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
    */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
    public FileReader(FileDescriptor fd) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
        super(new FileInputStream(fd));
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
49254
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    89
   /**
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    90
    * Creates a new {@code FileReader}, given the name of the file to read
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    91
    * and the {@linkplain java.nio.charset.Charset charset}.
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    92
    *
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    93
    * @param fileName the name of the file to read
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    94
    * @param charset the {@linkplain java.nio.charset.Charset charset}
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    95
    * @exception  IOException  if the named file does not exist,
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    96
    *                   is a directory rather than a regular file,
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    97
    *                   or for some other reason cannot be opened for
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    98
    *                   reading.
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
    99
    *
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
   100
    * @since 11
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
   101
    */
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
   102
    public FileReader(String fileName, Charset charset) throws IOException {
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
   103
        super(new FileInputStream(fileName), charset);
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
   104
    }
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
   105
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
   106
   /**
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
   107
    * Creates a new {@code FileReader}, given the {@code File} to read and
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
   108
    * the {@linkplain java.nio.charset.Charset charset}.
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
   109
    *
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
   110
    * @param file the {@code File} to read
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
   111
    * @param charset the {@linkplain java.nio.charset.Charset charset}
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
   112
    * @exception  IOException  if the file does not exist,
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
   113
    *                   is a directory rather than a regular file,
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
   114
    *                   or for some other reason cannot be opened for
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
   115
    *                   reading.
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
   116
    *
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
   117
    * @since 11
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
   118
    */
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
   119
    public FileReader(File file, Charset charset) throws IOException {
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
   120
        super(new FileInputStream(file), charset);
422615764e12 8183554: Add constructors with Charset parameter for FileReader and FileWriter
joehw
parents: 47216
diff changeset
   121
    }
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
}