Class StringReader
- All Implemented Interfaces:
-
Closeable
,AutoCloseable
,Readable
public class StringReader extends Reader
- Since:
- 1.1
Field Summary
Constructor Summary
Constructor | Description |
---|---|
StringReader |
Creates a new string reader. |
Method Summary
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. |
Methods declared in class java.io.Reader
nullReader, read, read, transferTo
Constructor Details
StringReader
public StringReader(String s)
- Parameters:
-
s
- String providing the character stream.
Method Details
read
public int read() throws IOException
- Overrides:
-
read
in classReader
- Returns:
- The character read, or -1 if the end of the stream has been reached
- Throws:
-
IOException
- If an I/O error occurs
read
public 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
.
- Specified by:
-
read
in classReader
- 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:
-
IndexOutOfBoundsException
- Ifoff
is negative, orlen
is negative, orlen
is greater thancbuf.length - off
-
IOException
- If an I/O error occurs
skip
public 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
.
- Overrides:
-
skip
in classReader
- Parameters:
-
n
- The number of characters to skip - Returns:
- The number of characters actually skipped
- Throws:
-
IOException
- If an I/O error occurs
ready
public boolean ready() throws IOException
- Overrides:
-
ready
in classReader
- Returns:
- True if the next read() is guaranteed not to block for input
- Throws:
-
IOException
- If the stream is closed
markSupported
public boolean markSupported()
- Overrides:
-
markSupported
in classReader
- Returns:
- true if and only if this stream supports the mark operation.
mark
public void mark(int readAheadLimit) throws IOException
- Overrides:
-
mark
in classReader
- 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:
-
IllegalArgumentException
- IfreadAheadLimit < 0
-
IOException
- If an I/O error occurs
reset
public void reset() throws IOException
- Overrides:
-
reset
in classReader
- Throws:
-
IOException
- If an I/O error occurs
close
public void close()
© 1993, 2021, 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/17/docs/api/java.base/java/io/StringReader.html