# StringReader

public class **StringReader** extends [Reader](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html)  
A character stream whose source is a string.

### Inherited Field Summary

From class [java.io.Reader](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html)

|---|---|---|
| protected [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [lock](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html#lock) | The object used to synchronize operations on this stream. |

### Public Constructor Summary

|---|---|
|   | [StringReader](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringReader.html#StringReader(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) s) Creates a new string reader. |

### Public Method Summary

|---|---|
| void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringReader.html#close())() Closes the stream and releases any system resources associated with it. |
| void | [mark](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringReader.html#mark(int))(int readAheadLimit) Marks the present position in the stream. |
| boolean | [markSupported](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringReader.html#markSupported())() Tells whether this stream supports the mark() operation, which it does. |
| int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringReader.html#read())() Reads a single character. |
| int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringReader.html#read(char[],%20int,%20int))(char\[\] cbuf, int off, int len) Reads characters into a portion of an array. |
| boolean | [ready](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringReader.html#ready())() Tells whether this stream is ready to be read. |
| void | [reset](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringReader.html#reset())() Resets the stream to the most recent mark, or to the beginning of the string if it has never been marked. |
| long | [skip](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/StringReader.html#skip(long))(long ns) Skips the specified number of characters in the stream. |

### Inherited Method Summary

From class [java.io.Reader](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html)

|---|---|
| abstract void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html#close())() Closes the stream and releases any system resources associated with it. |
| void | [mark](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html#mark(int))(int readAheadLimit) Marks the present position in the stream. |
| boolean | [markSupported](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html#markSupported())() Tells whether this stream supports the mark() operation. |
| int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html#read())() Reads a single character. |
| abstract int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html#read(char[],%20int,%20int))(char\[\] cbuf, int off, int len) Reads characters into a portion of an array. |
| int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html#read(char[]))(char\[\] cbuf) Reads characters into an array. |
| int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html#read(java.nio.CharBuffer))([CharBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/CharBuffer.html) target) Attempts to read characters into the specified character buffer. |
| boolean | [ready](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html#ready())() Tells whether this stream is ready to be read. |
| void | [reset](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html#reset())() Resets the stream. |
| long | [skip](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html#skip(long))(long n) Skips characters. |

From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\> | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#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](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#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](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(long timeout, 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](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(long timeout) 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](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |

From interface [java.lang.Readable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Readable.html)

|---|---|
| abstract int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Readable.html#read(java.nio.CharBuffer))([CharBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/CharBuffer.html) cb) Attempts to read characters into the specified character buffer. |

From interface [java.io.Closeable](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Closeable.html)

|---|---|
| abstract void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Closeable.html#close())() Closes this stream and releases any system resources associated with it. |

From interface [java.lang.AutoCloseable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/AutoCloseable.html)

|---|---|
| abstract void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/AutoCloseable.html#close())() Closes this resource, relinquishing any underlying resources. |

## Public Constructors

#### public
**StringReader**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) s)

Creates a new string reader.

##### Parameters

| s | String providing the character stream. |
|---|---|

## Public Methods

#### 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.

#### public void
**mark**
(int readAheadLimit)

Marks the present position in the stream. Subsequent calls to reset()
will reposition the stream to this point.

##### 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](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | If `readAheadLimit < 0` |
| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | If an I/O error occurs |
|---|---|

#### public boolean
**markSupported**
()

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

##### Returns

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

#### public int
**read**
()

Reads a single character.

##### Returns

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

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | If an I/O error occurs |
|---|---|

#### public int
**read**
(char\[\] cbuf, int off, int len)

Reads characters into a portion of an array.

##### Parameters

| cbuf | Destination buffer |
| off | Offset at which to start writing 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

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | If an I/O error occurs |
|---|---|

#### public boolean
**ready**
()

Tells whether this stream is ready to be read.

##### Returns

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

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | If the stream is closed |
|---|---|

#### public 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](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | If an I/O error occurs |
|---|---|

#### public 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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html` 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 | The number of characters to skip |
|---|---|

##### Returns

- The number of characters actually skipped

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | If an I/O error occurs |
|---|---|