- java.lang.Object
-
- java.io.Reader
-
- java.io.StringReader
-
- All Implemented Interfaces:
- Closeable, AutoCloseable, Readable
public class StringReader extends Reader
A character stream whose source is a string.- Since:
- JDK1.1
-
-
Field Summary
-
Fields inherited from class java.io.Reader
lock
-
-
Constructor Summary
Constructors Constructor and Description StringReader(String s)
Creates a new string reader.
-
Method Summary
Methods Modifier and Type Method and Description 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.
-
-
-
Constructor Detail
-
StringReader
public StringReader(String s)
Creates a new string reader.- Parameters:
s
- String providing the character stream.
-
-
Method Detail
-
read
public int read() throws IOException
Reads a single character.- 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
Reads characters into a portion of an array.- Specified by:
read
in classReader
- Parameters:
cbuf
- Destination bufferoff
- Offset at which to start writing characterslen
- Maximum number of characters to read- Returns:
- The number of characters read, or -1 if the end of the stream has been reached
- Throws:
IOException
- If an I/O error occurs
-
skip
public 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 theskip
method of theReader
superclass throws an exception in this case. Negative values ofns
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:
ns
- 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
Tells whether this stream is ready to be read.- 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()
Tells whether this stream supports the mark() operation, which it does.- Overrides:
markSupported
in classReader
- Returns:
- true if and only if this stream supports the mark operation.
-
mark
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.- 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
- If readAheadLimit is < 0IOException
- If an I/O error occurs
-
reset
public 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.- Overrides:
reset
in classReader
- Throws:
IOException
- If an I/O error occurs
-
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.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/io/StringReader.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.