All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.io.StringReader 

java.lang.Object
   |
   +----java.io.Reader
           |
           +----java.io.StringReader
public class StringReader
extends Reader
A character stream whose source is a string.

Constructor Index

o StringReader(String)
Create a new string reader.

Method Index

o close()
Close the stream.
o mark(int)
Mark the present position in the stream.
o markSupported()
Tell whether this stream supports the mark() operation, which it does.
o read()
Read a single character.
o read(char[], int, int)
Read characters into a portion of an array.
o ready()
Tell whether this stream is ready to be read.
o reset()
Reset the stream to the most recent mark, or to the beginning of the string if it has never been marked.
o skip(long)
Skip characters.

Constructors

o StringReader 
 public StringReader(String s)
Create a new string reader.

Methods

o read 
 public int read() throws IOException
Read a single character.

Returns:
The character read, or -1 if the end of the stream has been reached
Throws: IOException
If an I/O error occurs
Overrides:
read in class Reader
o read 
 public int read(char cbuf[],
                 int off,
                 int len) throws IOException
Read characters into a portion of an array.

Parameters:
cbuf - Destination buffer
off - Offset at which to start writing 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
Overrides:
read in class Reader
o skip 
 public long skip(long ns) throws IOException
Skip characters.

Throws: IOException
If an I/O error occurs
Overrides:
skip in class Reader
o ready 
 public boolean ready()
Tell whether this stream is ready to be read. String readers are always ready to be read.

Overrides:
ready in class Reader
o markSupported 
 public boolean markSupported()
Tell whether this stream supports the mark() operation, which it does.

Overrides:
markSupported in class Reader
o mark 
 public void mark(int readAheadLimit) throws IOException
Mark the present position in the stream. Subsequent calls to reset() will reposition the stream to this point.

Parameters:
readAheadLimit - Limit on the number of characters that may be read while still preserving the mark. Because the stream's input comes from a string, there is no actual limit, so this argument is ignored.
Throws: IOException
If an I/O error occurs
Overrides:
mark in class Reader
o reset 
 public void reset() throws IOException
Reset the stream to the most recent mark, or to the beginning of the string if it has never been marked.

Throws: IOException
If an I/O error occurs
Overrides:
reset in class Reader
o close 
 public void close()
Close the stream.

Overrides:
close in class Reader 
All Packages  Class Hierarchy  This Package  Previous  Next  Index