|
FlexDoc/Javadoc 2.0 Demo Java Doc |
Class InputStreamReader
java.io.InputStreamReader
All Implemented Interfaces:
Direct Known Subclasses:
public class InputStreamReader
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(anInputStream));
Since:
1.1
Author:
Mark Reinhold
See Also:
Fields inherited from class java.io. Reader |
|
Constructor Summary |
|
Creates an InputStreamReader that uses the given charset.
|
Creates an InputStreamReader that uses the given charset decoder.
|
Creates an InputStreamReader that uses the named charset.
|
Method Summary |
void |
Closes the stream and releases any system resources associated with
it.
|
|
Returns the name of the character encoding being used by this stream.
|
int |
Reads a single character.
|
int |
read(char[] cbuf, int off, int len)
Reads characters into a portion of an array.
|
int |
Attempts to read characters into the specified character buffer.
|
boolean |
Tells whether this stream is ready to be read.
|
Methods inherited from class java.io. Reader |
|
Methods inherited from class java.lang. Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Creates an InputStreamReader that uses the
default charset.
Parameters:
in - An InputStream
See Also:
public InputStreamReader |
|
throws |
|
Creates an InputStreamReader that uses the named charset.
Parameters:
in - An InputStream
charsetName - The name of a supported
charset Throws:
Creates an InputStreamReader that uses the given charset.
Parameters:
in - An InputStream
cs - A charset
Since:
1.4
Creates an InputStreamReader that uses the given charset decoder.
Parameters:
in - An InputStream
dec - A charset decoder
Since:
1.4
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 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
See Also:
Description copied from class:
Reader
Attempts to read characters into the specified character buffer.
The buffer is used as a repository of characters as-is: the only
changes made are the results of a put operation. No flipping or
rewinding of the buffer is performed.
Specified by:
Overrides:
Parameters:
target - the buffer to read characters into
Returns:
The number of characters added to the buffer, or
-1 if this source of characters is at its end
Throws:
public int read |
() |
throws |
|
Reads a single character.
Overrides:
Returns:
The character read, or -1 if the end of the stream has been
reached
Throws:
public int read |
(char[] cbuf, int off, int len) |
throws |
|
Reads characters into a portion of an array. This method will block
until some input is available, an I/O error occurs, or the end of the
stream is reached.
If len is zero, then no characters are read and 0 is
returned; otherwise, there is an attempt to read at least one character.
If no character is available because the stream is at its end, the value
-1 is returned; otherwise, at least one character is read and
stored into cbuf.
Overrides:
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:
public boolean ready |
() |
throws |
|
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:
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:
public void close |
() |
throws |
|
Description copied from class:
Reader
Closes the stream and releases any system resources associated with
it. Once the stream has been closed, further read(), ready(),
mark(), reset(), or skip() invocations will throw an IOException.
Closing a previously closed stream has no effect.
Specified by:
Overrides:
Throws:
|
FlexDoc/Javadoc 2.0 Demo Java Doc |
FlexDoc/Javadoc is a template-driven programming tool for rapid development of any Javadoc-based Java API documentation generators (i.e. doclets). If you need to customize your Javadoc without writing a full-blown doclet from scratch,
FlexDoc/Javadoc may be the only tool able to help you! Find out more at
www.flexdoc.xyz