InputStreamReader (Java 2 Platform SE 5.0) (original) (raw)

java.io

Class InputStreamReader

java.lang.Object extended by java.io.Reader java.io.InputStreamReader

All Implemented Interfaces:

Closeable, Readable

Direct Known Subclasses:

FileReader

public class InputStreamReader

extends Reader

An InputStreamReader is a bridge from byte streams to character streams: It reads bytes and decodes them into characters using a specified charset. The charset that it uses may be specified by name or may be given explicitly, or the platform's default charset may be accepted.

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(System.in));

Since:

JDK1.1

See Also:

BufferedReader, InputStream, Charset

Field Summary

Fields inherited from class java.io.Reader
lock

Constructor Summary
InputStreamReader(InputStream in) Create an InputStreamReader that uses the default charset.
[InputStreamReader](../../java/io/InputStreamReader.html#InputStreamReader%28java.io.InputStream, java.nio.charset.Charset%29)(InputStream in,Charset cs) Create an InputStreamReader that uses the given charset.
[InputStreamReader](../../java/io/InputStreamReader.html#InputStreamReader%28java.io.InputStream, java.nio.charset.CharsetDecoder%29)(InputStream in,CharsetDecoder dec) Create an InputStreamReader that uses the given charset decoder.
[InputStreamReader](../../java/io/InputStreamReader.html#InputStreamReader%28java.io.InputStream, java.lang.String%29)(InputStream in,String charsetName) Create an InputStreamReader that uses the named charset.

Method Summary
void	close() Close the stream.
String	getEncoding() Return the name of the character encoding being used by this stream.
int	read() Read a single character.
int	[read](../../java/io/InputStreamReader.html#read%28char[], int, int%29)(char[] cbuf, int offset, int length) Read characters into a portion of an array.
boolean	ready() Tell whether this stream is ready to be read.

Methods inherited from class java.io.Reader
mark, markSupported, read, read, reset, skip

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../java/lang/Object.html#wait%28long, int%29)

Constructor Detail

InputStreamReader

public InputStreamReader(InputStream in)

Create an InputStreamReader that uses the default charset.

Parameters:

in - An InputStream

InputStreamReader

public InputStreamReader(InputStream in, String charsetName) throws UnsupportedEncodingException

Create an InputStreamReader that uses the named charset.

Parameters:

in - An InputStream

charsetName - The name of a supportedcharset

Throws:

[UnsupportedEncodingException](../../java/io/UnsupportedEncodingException.html "class in java.io") - If the named charset is not supported

InputStreamReader

public InputStreamReader(InputStream in, Charset cs)

Create an InputStreamReader that uses the given charset.

Parameters:

in - An InputStream

cs - A charset

Since:

1.4

InputStreamReader

public InputStreamReader(InputStream in, CharsetDecoder dec)

Create an InputStreamReader that uses the given charset decoder.

Parameters:

in - An InputStream

dec - A charset decoder

Since:

1.4

Method Detail

getEncoding

public String getEncoding()

Return the name of the character encoding being used by this stream.

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)](../../java/io/InputStreamReader.html#InputStreamReader%28java.io.InputStream, java.lang.String%29) constructor then the returned name, being unique for the encoding, may differ from the name passed to the constructor. This method may return null if the stream has been closed.

Returns:

The historical name of this encoding, or possiblynull if the stream has been closed

See Also:

Charset

read

public int read() throws IOException

Read a single character.

Overrides:

[read](../../java/io/Reader.html#read%28%29) in class [Reader](../../java/io/Reader.html "class in java.io")

Returns:

The character read, or -1 if the end of the stream has been reached

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - If an I/O error occurs

read

public int read(char[] cbuf, int offset, int length) throws IOException

Read characters into a portion of an array.

Specified by:

[read](../../java/io/Reader.html#read%28char[], int, int%29) in class [Reader](../../java/io/Reader.html "class in java.io")

Parameters:

cbuf - Destination buffer

offset - Offset at which to start storing characters

length - Maximum number of characters to read

Returns:

The number of characters read, or -1 if the end of the stream has been reached

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - If an I/O error occurs

ready

public boolean ready() throws IOException

Tell whether this stream is ready to be read. An InputStreamReader is ready if its input buffer is not empty, or if bytes are available to be read from the underlying byte stream.

Overrides:

[ready](../../java/io/Reader.html#ready%28%29) in class [Reader](../../java/io/Reader.html "class in java.io")

Returns:

True if the next read() is guaranteed not to block for input, false otherwise. Note that returning false does not guarantee that the next read will block.

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - If an I/O error occurs

close

public void close() throws IOException

Close the stream.

Specified by:

[close](../../java/io/Closeable.html#close%28%29) in interface [Closeable](../../java/io/Closeable.html "interface in java.io")

Specified by:

[close](../../java/io/Reader.html#close%28%29) in class [Reader](../../java/io/Reader.html "class in java.io")

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - If an I/O error occurs

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.