public class StringReader extends Reader
A character stream whose source is a string.
lock
public StringReader(String s)
Creates a new string reader.
s
- String providing the character stream.public int read() throws IOException
Reads a single character.
read
in class Reader
IOException
- If an I/O error occurspublic int read(char[] cbuf, int off, int len) throws IOException
Reads characters into a portion of an array.
read
in class Reader
cbuf
- Destination bufferoff
- Offset at which to start writing characterslen
- Maximum number of characters to readIOException
- If an I/O error occurspublic long skip(long ns) throws IOException
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.
skip
in class Reader
ns
- The number of characters to skipIOException
- If an I/O error occurspublic boolean ready() throws IOException
Tells whether this stream is ready to be read.
ready
in class Reader
IOException
- If the stream is closedpublic boolean markSupported()
Tells whether this stream supports the mark() operation, which it does.
markSupported
in class Reader
public void mark(int readAheadLimit) throws IOException
Marks the present position in the stream. Subsequent calls to reset() will reposition the stream to this point.
mark
in class Reader
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.IllegalArgumentException
- If readAheadLimit < 0
IOException
- If an I/O error occurspublic void reset() throws IOException
Resets the stream to the most recent mark, or to the beginning of the string if it has never been marked.
reset
in class Reader
IOException
- If an I/O error occurspublic 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.
close
in interface Closeable
close
in interface AutoCloseable
close
in class Reader
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.