OpenJDK 1.22 · java.io.StringReader · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private final int	length
private int	mark
private int	next
private String	str

Access	Constructor and Description
public	StringReader(String String providing the character stream. s) Creates a new string reader.

Method Summary

Modifier and Type	Method and Description
public void	close() Implements abstract java.io.Reader.close. Implements java.io.Closeable.close. Closes the stream and releases any system resources associated with it.
private void	ensureOpen() Check to make sure that the stream has not been closed
public void	mark(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. readAheadLimit) Overrides java.io.Reader.mark. Marks the present position in the stream.
public boolean	markSupported() Overrides java.io.Reader.markSupported. Tells whether this stream supports the mark() operation, which it does.
public int	Returns: The character read, or -1 if the end of the stream has been reached read() Overrides java.io.Reader.read. Reads a single character.
public int	Returns: The number of characters read, or -1 if the end of the stream has been reached read(char[] Destination buffer cbuf, int Offset at which to start storing characters off, int Maximum number of characters to read len) Implements abstract java.io.Reader.read. Reads characters into a portion of an array.
public boolean	Returns: True if the next read() is guaranteed not to block for input ready() Overrides java.io.Reader.ready. Tells whether this stream is ready to be read.
public void	reset() Overrides java.io.Reader.reset. Resets the stream to the most recent mark, or to the beginning of the string if it has never been marked.
public long	Returns: The number of characters actually skipped skip(long The number of characters to skip n) Overrides java.io.Reader.skip. Skips characters.

Inherited from java.io.Reader:: nullReader read read transferTo

length	back to summary
private final int length

mark	back to summary
private int mark

next	back to summary
private int next

str	back to summary
private String str

StringReader	back to summary
public StringReader(String s) Creates a new string reader. Parameters s:String String providing the character stream.

Method Detail

close	back to summary
public void close() Implements abstract java.io.Reader.close. Implements java.io.Closeable.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.

back to summary

public void close()

Implements abstract java.io.Reader.close.

Implements java.io.Closeable.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.

ensureOpen	back to summary
private void ensureOpen() throws IOException Check to make sure that the stream has not been closed

mark back to summary

mark	back to summary
public void mark(int readAheadLimit) throws IOException Overrides java.io.Reader.mark. 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. Exceptions IOException: If an I/O error occurs IllegalArgumentException: If `readAheadLimit < 0`

public void mark(int readAheadLimit) throws IOException

Overrides java.io.Reader.mark.

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.

Exceptions

IOException:: If an I/O error occurs
IllegalArgumentException:: If readAheadLimit < 0

markSupported	back to summary
public boolean markSupported() Overrides java.io.Reader.markSupported. Tells whether this stream supports the mark() operation, which it does. Returns:boolean Doc from java.io.Reader.markSupported. true if and only if this stream supports the mark operation.

markSupported

back to summary

public boolean markSupported()

Overrides java.io.Reader.markSupported.

Tells whether this stream supports the mark() operation, which it does.

Returns:boolean

Doc from java.io.Reader.markSupported.

true if and only if this stream supports the mark operation.

read	back to summary
public int read() throws IOException Overrides java.io.Reader.read. Reads a single character. Returns:int The character read, or -1 if the end of the stream has been reached Exceptions IOException: If an I/O error occurs

read

back to summary

public int read() throws IOException

Overrides java.io.Reader.read.

Reads a single character.

Returns:int

The character read, or -1 if the end of the stream has been reached

Exceptions

IOException:: If an I/O error occurs

read back to summary

read	back to summary
public int read(char[] cbuf, int off, int len) throws IOException Implements abstract java.io.Reader.read. Reads characters into a portion of an array. 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`. Parameters cbuf:char[] Doc from java.io.Reader.read. Destination buffer off:int Doc from java.io.Reader.read. Offset at which to start storing characters len:int Doc from java.io.Reader.read. Maximum number of characters to read Returns:int Doc from java.io.Reader.read. The number of characters read, or -1 if the end of the stream has been reached Exceptions IOException: If an I/O error occurs IndexOutOfBoundsException: If `off` is negative, or `len` is negative, or `len` is greater than `cbuf.length - off`

public int read(char[] cbuf, int off, int len) throws IOException

Implements abstract java.io.Reader.read.

Reads characters into a portion of an array.

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.

Parameters

cbuf:char[]

Doc from java.io.Reader.read.

Destination buffer

off:int

Doc from java.io.Reader.read.

Offset at which to start storing characters

len:int

Doc from java.io.Reader.read.

Maximum number of characters to read

Returns:int

Doc from java.io.Reader.read.

The number of characters read, or -1 if the end of the stream has been reached

Exceptions

IOException:: If an I/O error occurs
IndexOutOfBoundsException:: If off is negative, or len is negative, or len is greater than cbuf.length - off

ready	back to summary
public boolean ready() throws IOException Overrides java.io.Reader.ready. Tells whether this stream is ready to be read. Returns:boolean True if the next read() is guaranteed not to block for input Exceptions IOException: If the stream is closed

ready

back to summary

public boolean ready() throws IOException

Overrides java.io.Reader.ready.

Tells whether this stream is ready to be read.

Returns:boolean

True if the next read() is guaranteed not to block for input

Exceptions

IOException:: If the stream is closed

reset	back to summary
public void reset() throws IOException Overrides java.io.Reader.reset. Resets the stream to the most recent mark, or to the beginning of the string if it has never been marked. Exceptions IOException: If an I/O error occurs

reset

back to summary

public void reset() throws IOException

Overrides java.io.Reader.reset.

Resets the stream to the most recent mark, or to the beginning of the string if it has never been marked.

Exceptions

IOException:: If an I/O error occurs

skip back to summary

skip	back to summary
public long skip(long n) throws IOException Overrides java.io.Reader.skip. Skips characters. If the stream is already at its end before this method is invoked, then no characters are skipped and zero is returned. 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`. Parameters n:long Doc from java.io.Reader.skip. The number of characters to skip Returns:long Doc from java.io.Reader.skip. The number of characters actually skipped Exceptions IOException: If an I/O error occurs

public long skip(long n) throws IOException

Overrides java.io.Reader.skip.

Skips characters. If the stream is already at its end before this method is invoked, then no characters are skipped and zero is returned.

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.

Parameters

n:long

Doc from java.io.Reader.skip.

The number of characters to skip

Returns:long

Doc from java.io.Reader.skip.

The number of characters actually skipped

Exceptions

IOException:: If an I/O error occurs

public Class StringReader

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail