|
FlexDoc/Javadoc 2.0 Demo Java Doc |
Class StringReader
java.io.StringReader
All Implemented Interfaces:
public class StringReader
A character stream whose source is a string.
Since:
1.1
Author:
Mark Reinhold
Fields inherited from class java.io. Reader |
|
Constructor Summary |
Creates a new string reader.
|
Method Summary |
void |
Closes the stream and releases any system resources associated with
it.
|
void |
Marks the present position in the stream.
|
boolean |
Tells whether this stream supports the mark() operation, which it does.
|
int |
Reads a single character.
|
int |
read(char[] cbuf, int off, int len)
Reads characters into a portion of an array.
|
boolean |
Tells whether this stream is ready to be read.
|
void |
Resets the stream to the most recent mark, or to the beginning of the
string if it has never been marked.
|
long |
Skips characters.
|
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 a new string reader.
Parameters:
s - String providing the character stream.
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.
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 long skip |
(long n) |
throws |
|
Skips characters. If the stream is already at its end before this method
is invoked, then no characters are skipped and zero is returned.
The n parameter may be negative, even though the
skip method of the Reader superclass throws
an exception in this case. Negative values of n cause the
stream to skip backwards. Negative return values indicate a skip
backwards. It is not possible to skip backwards past the beginning of
the string.
If the entire string has been read or skipped, then this method has
no effect and always returns 0.
Overrides:
Parameters:
n - The number of characters to skip
Returns:
The number of characters actually skipped
Throws:
public boolean ready |
() |
throws |
|
Tells whether this stream is ready to be read.
Overrides:
Returns:
True if the next read() is guaranteed not to block for input
Throws:
public boolean markSupported |
() |
Tells whether this stream supports the mark() operation, which it does.
Overrides:
Returns:
true if and only if this stream supports the mark operation.
public void mark |
(int readAheadLimit) |
throws |
|
Marks the present position in the stream. Subsequent calls to reset()
will reposition the stream to this point.
Overrides:
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 must not
be negative, but is otherwise ignored.
Throws:
public void reset |
() |
throws |
|
Resets the stream to the most recent mark, or to the beginning of the
string if it has never been marked.
Overrides:
Throws:
Closes the stream and releases any system resources associated with
it. Once the stream has been closed, further read(),
ready(), mark(), or reset() invocations will throw an IOException.
Closing a previously closed stream has no effect. This method will block
while there is another thread blocking on the reader.
Specified by:
Overrides:
|
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