Skip to content

Most visited

Recently visited

navigation

StringReader

public class StringReader
extends Reader

java.lang.Object
   ↳ java.io.Reader
     ↳ java.io.StringReader


A character stream whose source is a string.

Summary

Inherited fields

From class java.io.Reader

Public constructors

StringReader(String s)

Creates a new string reader.

Public methods

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.

Inherited methods

From class java.io.Reader
From class java.lang.Object
From interface java.lang.Readable
From interface java.io.Closeable
From interface java.lang.AutoCloseable

Public constructors

StringReader

Added in API level 1
StringReader (String s)

Creates a new string reader.

Parameters
s String: String providing the character stream.

Public methods

close

Added in API level 1
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.

mark

Added in API level 1
void mark (int readAheadLimit)

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.
Throws
IllegalArgumentException If readAheadLimit is < 0
IOException If an I/O error occurs

markSupported

Added in API level 1
boolean markSupported ()

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

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

read

Added in API level 1
int read ()

Reads a single character.

Returns
int The character read, or -1 if the end of the stream has been reached
Throws
IOException If an I/O error occurs

read

Added in API level 1
int read (char[] cbuf, 
                int off, 
                int len)

Reads characters into a portion of an array.

Parameters
cbuf char: Destination buffer
off int: Offset at which to start writing characters
len int: Maximum number of characters to read
Returns
int The number of characters read, or -1 if the end of the stream has been reached
Throws
IOException If an I/O error occurs

ready

Added in API level 1
boolean ready ()

Tells whether this stream is ready to be read.

Returns
boolean True if the next read() is guaranteed not to block for input
Throws
IOException If the stream is closed

reset

Added in API level 1
void reset ()

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

Throws
IOException If an I/O error occurs

skip

Added in API level 1
long skip (long ns)

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.

Parameters
ns long: The number of characters to skip
Returns
long The number of characters actually skipped
Throws
IOException If an I/O error occurs
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.