java.io.FixedInputStreamReader Class Reference

Inheritance diagram for java.io.FixedInputStreamReader:

List of all members.

---

Detailed Description

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:

• 8859_1 (ISO-8859-1/Latin-1)
• 8859_2 (ISO-8859-2/Latin-2)
• 8859_3 (ISO-8859-3/Latin-3)
• 8859_4 (ISO-8859-4/Latin-4)
• 8859_5 (ISO-8859-5/Latin-5)
• 8859_6 (ISO-8859-6/Latin-6)
• 8859_7 (ISO-8859-7/Latin-7)
• 8859_8 (ISO-8859-8/Latin-8)
• 8859_9 (ISO-8859-9/Latin-9)
• ASCII (7-bit ASCII)
• UTF8 (UCS Transformation Format-8)
• More later

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.

See also:

BufferedReader

InputStream

Author:

Aaron M. Renn (arenn@urbanophile.com)

Per Bothner <bothner@cygnus.com>

Date:

April 22, 1998.

Public Member Functions
	FixedInputStreamReader (InputStream in)
	This method initializes a new instance of InputStreamReader to read from the specified stream using the default encoding.
	FixedInputStreamReader (InputStream in, String encoding_name) throws UnsupportedEncodingException
	This method initializes a new instance of InputStreamReader to read from the specified stream using a caller supplied character encoding scheme.
void	close () throws IOException
	This method closes this stream, as well as the underlying InputStream.
String	getEncoding ()
	This method returns the name of the encoding that is currently in use by this object.
boolean	ready () throws IOException
	This method checks to see if the stream is read to be read.
int	read (char[] buf, int offset, int length) throws IOException
	This method reads up to length characters from the stream into the specified array starting at index offset into the array.
int	read () throws IOException
	This method reads a single character of data from the stream.
Package Attributes
BufferedInputStream	in
char[]	work
int	wpos
int	wcount
BytesToUnicode	converter

---

Constructor & Destructor Documentation

java.io.FixedInputStreamReader.FixedInputStreamReader (  InputStream  in  )

This method initializes a new instance of InputStreamReader to read from the specified stream using the default encoding. Parameters: in  The InputStream to read from

java.io.FixedInputStreamReader.FixedInputStreamReader (  InputStream  in, String  encoding_name )  throws UnsupportedEncodingException

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: in  The InputStream to read from encoding_name  The name of the encoding scheme to use Exceptions: UnsupportedEncodingException  If the encoding scheme requested is not available.

---

Member Function Documentation

void java.io.FixedInputStreamReader.close (   )  throws IOException

This method closes this stream, as well as the underlying InputStream. Exceptions: IOException  If an error occurs

String java.io.FixedInputStreamReader.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. Parameters: The  current encoding name

int java.io.FixedInputStreamReader.read (   )  throws IOException

This method reads a single character of data from the stream. Returns: The char read, as an int, or -1 if end of stream. Exceptions: IOException  If an error occurs

int java.io.FixedInputStreamReader.read (  char[]  buf, int  offset, int  length )  throws IOException

This method reads up to length characters from the stream into the specified array starting at index offset into the array. Parameters: buf  The character array to recieve the data read offset  The offset into the array to start storing characters length  The requested number of characters to read. Returns: The actual number of characters read, or -1 if end of stream. Exceptions: IOException  If an error occurs

boolean java.io.FixedInputStreamReader.ready (   )  throws IOException

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: true if the stream is ready to be read, false otherwise Exceptions: IOException  If an error occurs

---

Member Data Documentation

BytesToUnicode java.io.FixedInputStreamReader.converter [package]

BufferedInputStream java.io.FixedInputStreamReader.in [package]

int java.io.FixedInputStreamReader.wcount [package]

char [] java.io.FixedInputStreamReader.work [package]

int java.io.FixedInputStreamReader.wpos [package]

---

The documentation for this class was generated from the following file:

• director/java/io/FixedInputStreamReader.java

---