This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 

java.io
class InputStreamReader

java.lang.Object extended by java.io.Reader extended by java.io.InputStreamReader
All Implemented Interfaces:
Closeable, Readable
Direct Known Subclasses:
FileReader
Most common way to construct:

InputStream is = …;

InputStreamReader isr = new InputStreamReader(is);

Based on 51 examples 

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 {@link java.nio.charset.Charset 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));

See Also (auto-generated):

BufferedReader

InputStream

File

Field Summary
 
Fields inherited from class java.io.Reader
lock
 
Constructor Summary
InputStreamReader(InputStream in)

          Creates an InputStreamReader that uses the default charset.
InputStreamReader(InputStream in, Charset cs)

          Creates an InputStreamReader that uses the given charset.
InputStreamReader(InputStream in, CharsetDecoder dec)

          Creates an InputStreamReader that uses the given charset decoder.
InputStreamReader(InputStream in, String charsetName)

          Creates an InputStreamReader that uses the named charset.
 
Method Summary
 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(char[] cbuf, int offset, int length)

          Reads characters into a portion of an array.
 boolean
ready()

          Tells whether this stream is ready to be read.
 
Methods inherited from class java.io.Reader
close, mark, markSupported, read, read, read, read, ready, reset, skip
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InputStreamReader

public InputStreamReader(InputStream in)
Creates an InputStreamReader that uses the default charset.

Parameters:
in - An InputStream

InputStreamReader

public InputStreamReader(InputStream in,
                         Charset cs)
Creates an InputStreamReader that uses the given charset.

Parameters:
in - An InputStream
cs - A charset

InputStreamReader

public InputStreamReader(InputStream in,
                         CharsetDecoder dec)
Creates an InputStreamReader that uses the given charset decoder.

Parameters:
in - An InputStream
dec - A charset decoder

InputStreamReader

public InputStreamReader(InputStream in,
                         String charsetName)
                  throws UnsupportedEncodingException
Creates an InputStreamReader that uses the named charset.

Parameters:
in - An InputStream
charsetName - The name of a supported {@link java.nio.charset.Charset charset}
Throws:
UnsupportedEncodingException - If the named charset is not supported
Method Detail

close

public void close()
           throws IOException
Overrides:
close in class Reader
Throws:
IOException

getEncoding

public String getEncoding()
Returns 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 {@link #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.

Returns:
The historical name of this encoding, or null if the stream has been closed

read

public int read()
         throws IOException
Reads a single character.

Overrides:
read in class Reader
Returns:
The character read, or -1 if the end of the stream has been reached
Throws:
IOException - If an I/O error occurs

read

public int read(char[] cbuf,
                int offset,
                int length)
         throws IOException
Reads characters into a portion of an array.

Overrides:
read in class Reader
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 - If an I/O error occurs

ready

public boolean ready()
              throws IOException
Tells 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 in class Reader
Throws:
IOException - If an I/O error occurs
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 
This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.