public class

InputStreamReader

extends Reader
java.lang.Object
   ↳ java.io.Reader
     ↳ java.io.InputStreamReader

Class Overview

An InputStreamReader is a bridge from byte streams to character streams: It reads bytes and translates them into characters. The encoding that it uses may be specified by name, or the platform's default encoding 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.

Summary

[Expand]
Inherited Fields
From class java.io.Reader
Public Constructors
InputStreamReader(InputStream is)
Create an InputStreamReader that uses the default character encoding.
InputStreamReader(InputStream is, String enc)
Create an InputStreamReader that uses the named character encoding.
Public Methods
void close()
Close the stream.
void mark(int readAheadLimit)
Mark the present position in the stream.
boolean markSupported()
Tell whether this stream supports the mark() operation.
int read()
Read a single character.
int read(char[] cbuf, int off, int len)
Read characters into a portion of an array.
boolean ready()
Tell whether this stream is ready to be read.
void reset()
Reset the stream.
long skip(long n)
Skip characters.
[Expand]
Inherited Methods
From class java.io.Reader
From class java.lang.Object

Public Constructors

public InputStreamReader (InputStream is)

Create an InputStreamReader that uses the default character encoding.

Parameters
is An InputStream

public InputStreamReader (InputStream is, String enc)

Create an InputStreamReader that uses the named character encoding.

Parameters
is An InputStream
enc The name of a supported
Throws
UnsupportedEncodingException If the named encoding is not supported

Public Methods

public void close ()

Close the stream.

Throws
IOException If an I/O error occurs

public void mark (int readAheadLimit)

Mark the present position in the stream.

Parameters
readAheadLimit Limit on the number of characters that may be read while still preserving the mark. After reading this many characters, attempting to reset the stream may fail.
Throws
IOException If an I/O error occurs

public boolean markSupported ()

Tell whether this stream supports the mark() operation.

Returns
  • true if and only if this stream supports the mark operation.

public int read ()

Read a single character.

Returns
  • The character read, as an integer in the range 0 to 65535 (0x00-0xffff), or -1 if the end of the stream has been reached
Throws
IOException If an I/O error occurs

public int read (char[] cbuf, int off, int len)

Read characters into a portion of an array.

Parameters
cbuf Destination buffer
off Offset at which to start storing characters
len 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 If an I/O error occurs

public boolean ready ()

Tell whether this stream is ready to be read.

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 If an I/O error occurs

public void reset ()

Reset the stream.

Throws
IOException If an I/O error occurs

public long skip (long n)

Skip characters.

Parameters
n The number of characters to skip
Returns
  • The number of characters actually skipped
Throws
IOException If an I/O error occurs