StringReader
public
class
StringReader
extends Reader
A character stream whose source is a string.
Summary
Inherited fields |
From class
java.io.Reader
protected
Object |
lock
The object used to synchronize operations on this stream.
|
|
Public methods |
void
|
close()
Closes the stream and releases any system resources associated with
it.
|
void
|
mark(int readAheadLimit)
Marks the present position in the stream.
|
boolean
|
markSupported()
Tells whether this stream supports the mark() operation, which it does.
|
int
|
read()
Reads a single character.
|
int
|
read(char[] cbuf, int off, int len)
Reads characters into a portion of an array.
|
boolean
|
ready()
Tells whether this stream is ready to be read.
|
void
|
reset()
Resets the stream to the most recent mark, or to the beginning of the
string if it has never been marked.
|
long
|
skip(long ns)
Skips the specified number of characters in the stream.
|
Inherited methods |
From class
java.io.Reader
abstract
void
|
close()
Closes the stream and releases any system resources associated with
it.
|
void
|
mark(int readAheadLimit)
Marks the present position in the stream.
|
boolean
|
markSupported()
Tells whether this stream supports the mark() operation.
|
static
Reader
|
nullReader()
Returns a new Reader that reads no characters.
|
int
|
read()
Reads a single character.
|
abstract
int
|
read(char[] cbuf, int off, int len)
Reads characters into a portion of an array.
|
int
|
read(char[] cbuf)
Reads characters into an array.
|
int
|
read(CharBuffer target)
Attempts to read characters into the specified character buffer.
|
boolean
|
ready()
Tells whether this stream is ready to be read.
|
void
|
reset()
Resets the stream.
|
long
|
skip(long n)
Skips characters.
|
long
|
transferTo(Writer out)
Reads all characters from this reader and writes the characters to the
given writer in the order that they are read.
|
|
From class
java.lang.Object
Object
|
clone()
Creates and returns a copy of this object.
|
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one.
|
void
|
finalize()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
|
final
Class<?>
|
getClass()
Returns the runtime class of this Object .
|
int
|
hashCode()
Returns a hash code value for the object.
|
final
void
|
notify()
Wakes up a single thread that is waiting on this object's
monitor.
|
final
void
|
notifyAll()
Wakes up all threads that are waiting on this object's monitor.
|
String
|
toString()
Returns a string representation of the object.
|
final
void
|
wait(long timeoutMillis, int nanos)
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted, or until a
certain amount of real time has elapsed.
|
final
void
|
wait(long timeoutMillis)
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted, or until a
certain amount of real time has elapsed.
|
final
void
|
wait()
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted.
|
|
From interface
java.io.Closeable
abstract
void
|
close()
Closes this stream and releases any system resources associated
with it.
|
|
From interface
java.lang.Readable
abstract
int
|
read(CharBuffer cb)
Attempts to read characters into the specified character buffer.
|
|
From interface
java.lang.AutoCloseable
abstract
void
|
close()
Closes this resource, relinquishing any underlying resources.
|
|
Public constructors
StringReader
public StringReader (String s)
Creates a new string reader.
Parameters |
s |
String : String providing the character stream. |
Public methods
close
public void close ()
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.
mark
public void mark (int readAheadLimit)
Marks the present position in the stream. Subsequent calls to reset()
will reposition the stream to this point.
Parameters |
readAheadLimit |
int : 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. |
markSupported
public boolean markSupported ()
Tells whether this stream supports the mark() operation, which it does.
Returns |
boolean |
true if and only if this stream supports the mark operation. |
read
public int read ()
Reads a single character.
Returns |
int |
The character read, or -1 if the end of the stream has been
reached |
read
public int read (char[] cbuf,
int off,
int len)
Reads characters into a portion of an array.
Parameters |
cbuf |
char : Destination buffer |
off |
int : Offset at which to start writing characters |
len |
int : Maximum number of characters to read |
Returns |
int |
The number of characters read, or -1 if the end of the
stream has been reached |
ready
public boolean ready ()
Tells whether this stream is ready to be read.
Returns |
boolean |
True if the next read() is guaranteed not to block for input |
reset
public void reset ()
Resets the stream to the most recent mark, or to the beginning of the
string if it has never been marked.
skip
public long skip (long ns)
Skips the specified number of characters in the stream. Returns
the number of characters that were skipped.
The ns
parameter may be negative, even though the
skip
method of the Reader
superclass throws
an exception in this case. Negative values of ns
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.
Parameters |
ns |
long : The number of characters to skip |
Returns |
long |
The number of characters actually skipped |