Closeable
, AutoCloseable
, Readable
FileReader
public class InputStreamReader extends Reader
charset
. The charset that it uses may be specified by name or may be given explicitly, or the default charset
may be used. Each invocation of one of an InputStreamReader's read() methods may cause one or more bytes to be read from the underlying byte-input stream. To enable the efficient conversion of bytes to characters, more bytes may be read ahead from the underlying stream than are necessary to satisfy the current read operation.
For top efficiency, consider wrapping an InputStreamReader within a BufferedReader. For example:
BufferedReader in = new BufferedReader(new InputStreamReader(anInputStream));
Constructor | Description |
---|---|
InputStreamReader |
Creates an InputStreamReader that uses the default charset . |
InputStreamReader |
Creates an InputStreamReader that uses the named charset. |
InputStreamReader |
Creates an InputStreamReader that uses the given charset. |
InputStreamReader |
Creates an InputStreamReader that uses the given charset decoder. |
Modifier and Type | Method | Description |
---|---|---|
void |
close() |
Closes the stream and releases any system resources associated with it. |
String |
getEncoding() |
Returns the name of the character encoding being used by this stream. |
int |
read() |
Reads a single character. |
int |
read |
Reads characters into a portion of an array. |
boolean |
ready() |
Tells whether this stream is ready to be read. |
mark, markSupported, nullReader, read, read, reset, skip, transferTo
public InputStreamReader(InputStream in)
default charset
.in
- An InputStreampublic InputStreamReader(InputStream in, String charsetName) throws UnsupportedEncodingException
in
- An InputStreamcharsetName
- The name of a supported charset
UnsupportedEncodingException
- If the named charset is not supportedpublic InputStreamReader(InputStream in, Charset cs)
in
- An InputStreamcs
- A charsetpublic InputStreamReader(InputStream in, CharsetDecoder dec)
in
- An InputStreamdec
- A charset decoderpublic String getEncoding()
If the encoding has an historical name then that name is returned; otherwise the encoding's canonical name is returned.
If this instance was created with the InputStreamReader(InputStream, String)
constructor then the returned name, being unique for the encoding, may differ from the name passed to the constructor. This method will return null
if the stream has been closed.
null
if the stream has been closedpublic int read() throws IOException
read
in class Reader
IOException
- If an I/O error occurspublic int read(char[] cbuf, int off, int len) throws IOException
If len
is zero, then no characters are read and 0
is returned; otherwise, there is an attempt to read at least one character. If no character is available because the stream is at its end, the value -1
is returned; otherwise, at least one character is read and stored into cbuf
.
read
in class Reader
cbuf
- Destination bufferoff
- Offset at which to start storing characterslen
- Maximum number of characters to readIndexOutOfBoundsException
- If off
is negative, or len
is negative, or len
is greater than cbuf.length - off
IOException
- If an I/O error occurspublic boolean ready() throws IOException
ready
in class Reader
IOException
- If an I/O error occurspublic void close() throws IOException
Reader
close
in interface AutoCloseable
close
in interface Closeable
close
in class Reader
IOException
- If an I/O error occurs
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/InputStreamReader.html