Closeable
, AutoCloseable
, Readable
public class StringReader extends Reader
Constructor | Description |
---|---|
StringReader |
Creates a new string reader. |
Modifier and Type | Method | Description |
---|---|---|
void |
close() |
Closes the stream and releases any system resources associated with it. |
void |
mark |
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 |
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 |
Skips characters. |
nullReader, read, read, transferTo
public StringReader(String s)
s
- String providing the character stream.public int read() throws IOException
read
in class Reader
IOException
- If an I/O error occurspublic int read(char[] cbuf, int off, int len) throws IOException
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
.
read
in class Reader
cbuf
- Destination bufferoff
- Offset at which to start storing characterslen
- Maximum number of characters to readIndexOutOfBoundsException
- If off
is negative, or len
is negative, or len
is greater than cbuf.length - off
IOException
- If an I/O error occurspublic long skip(long n) throws IOException
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
.
skip
in class Reader
n
- The number of characters to skipIOException
- If an I/O error occurspublic boolean ready() throws IOException
ready
in class Reader
IOException
- If the stream is closedpublic boolean markSupported()
markSupported
in class Reader
public void mark(int readAheadLimit) throws IOException
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
reset
in class Reader
IOException
- If an I/O error occurspublic void close()
© 1993, 2023, 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.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/StringReader.html