Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)

Summary: Inherited Fields | Ctors | Methods | Inherited Methods | [Expand All]

Added in API level 1

public class

StringReader

extends Reader

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

Class Overview

A specialized Reader that reads characters from a String in a sequential manner.

Summary

[Expand]

Inherited Fields

From class java.io.Reader

Public Constructors
	StringReader ( String str) Construct a new `StringReader` with `str` as source.

Public Methods
void	close () Closes this reader.
void	mark (int readLimit) Sets a mark position in this reader.
boolean	markSupported () Indicates whether this reader supports the `mark()` and `reset()` methods.
int	read () Reads a single character from the source string and returns it as an integer with the two higher-order bytes set to 0.
int	read (char[] buffer, int offset, int count) Reads up to `count` characters from the source string and stores them at `offset` in the character array `buffer` .
boolean	ready () Indicates whether this reader is ready to be read without blocking.
void	reset () Resets this reader's position to the last `mark()` location.
long	skip (long charCount) Moves `charCount` characters in the source string.

[Expand]

Inherited Methods

From class java.io.Reader

abstract void	close () Closes this reader.
void	mark (int readLimit) Sets a mark position in this reader.
boolean	markSupported () Indicates whether this reader supports the `mark()` and `reset()` methods.
int	read () Reads a single character from this reader and returns it as an integer with the two higher-order bytes set to 0.
abstract int	read (char[] buffer, int offset, int count) Reads up to `count` characters from this reader and stores them at `offset` in the character array `buffer` .
int	read ( CharBuffer target) Reads characters and puts them into the `target` character buffer.
int	read (char[] buffer) Reads characters from this reader and stores them in the character array `buffer` starting at offset 0.
boolean	ready () Indicates whether this reader is ready to be read without blocking.
void	reset () Resets this reader's position to the last `mark()` location.
long	skip (long charCount) Skips `charCount` characters in this reader.

From class java.lang.Object

Object	clone () Creates and returns a copy of this `Object` .
boolean	equals ( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize () Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class <?>	getClass () Returns the unique instance of `Class` that represents this object's class.
int	hashCode () Returns an integer hash code for this object.
final void	notify () Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll () Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString () Returns a string containing a concise, human-readable description of this object.
final void	wait () Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait (long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait (long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface java.io.Closeable

From interface java.lang.AutoCloseable

From interface java.lang.Readable

Public Constructors

public StringReader ( String str)

Added in API level 1

Construct a new StringReader with str as source. The size of the reader is set to the length() of the string and the Object to synchronize access through is set to str .

Parameters

str	the source string for this reader.

Public Methods

public void close ()

Added in API level 1

Closes this reader. Once it is closed, read operations on this reader will throw an IOException . Only the first invocation of this method has any effect.

public void mark (int readLimit)

Added in API level 1

Sets a mark position in this reader. The parameter readLimit is ignored for this class. Calling reset() will reposition the reader back to the marked position.

Parameters

readLimit	ignored for `StringReader` instances.

Throws

IllegalArgumentException	if `readLimit < 0` .
IOException	if this reader is closed.

public boolean markSupported ()

Added in API level 1

Indicates whether this reader supports the mark() and reset() methods. This implementation returns true .

Returns

always true .

public int read ()

Added in API level 1

Reads a single character from the source string and returns it as an integer with the two higher-order bytes set to 0. Returns -1 if the end of the source string has been reached.

Returns

the character read or -1 if the end of the source string has been reached.

Throws

IOException	if this reader is closed.

public int read (char[] buffer, int offset, int count)

Added in API level 1

Reads up to count characters from the source string and stores them at offset in the character array buffer . Returns the number of characters actually read or -1 if the end of the source string has been reached.

Throws

IndexOutOfBoundsException	if `offset < 0 \|\| count < 0 \|\| offset + count > buffer.length` .
IOException	if this reader is closed.

public boolean ready ()

Added in API level 1

Indicates whether this reader is ready to be read without blocking. This implementation always returns true .

Returns

always true .

Throws

IOException	if this reader is closed.

public void reset ()

Added in API level 1

Resets this reader's position to the last mark() location. Invocations of read() and skip() will occur from this new location. If this reader has not been marked, it is reset to the beginning of the source string.

Throws

IOException	if this reader is closed.

public long skip (long charCount)

Added in API level 1

Moves charCount characters in the source string. Unlike the overridden method , this method may skip negative skip distances: this rewinds the input so that characters may be read again. When the end of the source string has been reached, the input cannot be rewound.

Parameters

charCount	the maximum number of characters to skip. Positive values skip forward; negative values skip backward.

Returns

the number of characters actually skipped. This is bounded below by the number of characters already read and above by the number of characters remaining:
-(num chars already read) <= distance skipped <= num chars remaining .

Throws

IOException	if this reader is closed.

Results

Interfaces

Classes

Exceptions

Errors

StringReader

Class Overview

See Also

Summary

Public Constructors

public StringReader ( String str)

Parameters

Public Methods

public void close ()

public void mark (int readLimit)

Parameters

Throws

See Also

public boolean markSupported ()

Returns

public int read ()

Returns

Throws

public int read (char[] buffer, int offset, int count)

Throws

public boolean ready ()

Returns

Throws

See Also

public void reset ()

Throws

See Also

public long skip (long charCount)

Parameters

Returns

Throws

See Also