Index (Frames) | Index (No Frames) | Package | Package Tree | Tree
java.io

Class InputStreamReader

java.lang.Object
|
+--java.io.Reader
   |
   +--java.io.InputStreamReader


public class InputStreamReader

extends Reader

This class reads characters from a byte input stream. The characters read are converted from bytes in the underlying stream by a decoding layer. The decoding layer transforms bytes to chars according to an encoding standard. There are many available encodings to choose from. The desired encoding can either be specified by name, or if no encoding is selected, the system default encoding will be used. The system default encoding name is determined from the system property file.encoding. The only encodings that are guaranteed to be availalbe are "8859_1" (the Latin-1 character set) and "UTF8". Unforunately, Java does not provide a mechanism for listing the ecodings that are supported in a given implementation.

Here is a list of standard encoding names that may be available:

It is recommended that applications do not use InputStreamReader's directly. Rather, for efficiency purposes, an object of this class should be wrapped by a BufferedReader.

Due to a deficiency the Java class library design, there is no standard way for an application to install its own byte-character encoding.

Author:See Also:

Constructor Summary

InputStreamReader(java.io.InputStream in)

This method initializes a new instance of InputStreamReader to read from the specified stream using the default encoding.
InputStreamReader(java.io.InputStream in, java.lang.String encoding_name)

This method initializes a new instance of InputStreamReader to read from the specified stream using a caller supplied character encoding scheme.

Method Summary

voidclose()

This method closes this stream, as well as the underlying InputStream.
java.lang.StringgetEncoding()

This method returns the name of the encoding that is currently in use by this object.
intread()

This method reads a single character of data from the stream.
intread(char[] buf, int offset, int len)

This method reads up to len characters from the stream into the specified array starting at index offset into the array.
booleanready()

This method checks to see if the stream is read to be read.

Constructor Details

InputStreamReader

public InputStreamReader(java.io.InputStream in)

This method initializes a new instance of InputStreamReader to read from the specified stream using the default encoding.

Parameters:


InputStreamReader

public InputStreamReader(java.io.InputStream in, java.lang.String encoding_name)

This method initializes a new instance of InputStreamReader to read from the specified stream using a caller supplied character encoding scheme. Note that due to a deficiency in the Java language design, there is no way to determine which encodings are supported.

Parameters:

Throws:


Method Details

close

public void close()

This method closes this stream, as well as the underlying InputStream.

Throws:


getEncoding

public String getEncoding()

This method returns the name of the encoding that is currently in use by this object. If the stream has been closed, this method is allowed to return null.


read

public int read()

This method reads a single character of data from the stream.

Returns:

Throws:


read

public int read(char[] buf, int offset, int len)

This method reads up to len characters from the stream into the specified array starting at index offset into the array.

Parameters:

Returns:

Throws:


ready

public boolean ready()

This method checks to see if the stream is read to be read. It will return true if is, or false if it is not. If the stream is not ready to be read, it could (although is not required to) block on the next read attempt.

Returns:

Throws: