# CharArrayReader

public class **CharArrayReader** extends [Reader](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html)  
This class implements a character buffer that can be used as a
character-input stream.

### Field Summary

|---|---|---|
| protected char\[\] | [buf](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/CharArrayReader.html#buf) | The character buffer. |
| protected int | [count](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/CharArrayReader.html#count) | The index of the end of this buffer. |
| protected int | [markedPos](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/CharArrayReader.html#markedPos) | The position of mark in buffer. |
| protected int | [pos](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/CharArrayReader.html#pos) | The current buffer position. |

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

|---|---|
|   | [CharArrayReader](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/CharArrayReader.html#CharArrayReader(char[]))(char\[\] buf) Creates a CharArrayReader from the specified array of chars. |
|   | [CharArrayReader](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/CharArrayReader.html#CharArrayReader(char[],%20int,%20int))(char\[\] buf, int offset, int length) Creates a CharArrayReader from the specified array of chars. |

### Public Method Summary

|---|---|
| void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/CharArrayReader.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/CharArrayReader.html#mark(int))(int readAheadLimit) Marks the present position in the stream. |
| boolean | [markSupported](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/CharArrayReader.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/CharArrayReader.html#read())() Reads a single character. |
| int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/CharArrayReader.html#read(char[],%20int,%20int))(char\[\] b, int off, int len) Reads characters into a portion of an array. |
| boolean | [ready](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/CharArrayReader.html#ready())() Tells whether this stream is ready to be read. |
| void | [reset](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/CharArrayReader.html#reset())() Resets the stream to the most recent mark, or to the beginning if it has never been marked. |
| long | [skip](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/CharArrayReader.html#skip(long))(long n) Skips characters. |

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

## Fields

#### protected char\[\]
**buf**

The character buffer.

#### protected int
**count**

The index of the end of this buffer. There is not valid
data at or beyond this index.

#### protected int
**markedPos**

The position of mark in buffer.

#### protected int
**pos**

The current buffer position.

## Public Constructors

#### public
**CharArrayReader**
(char\[\] buf)

Creates a CharArrayReader from the specified array of chars.

##### Parameters

| buf | Input buffer (not copied) |
|---|---|

#### public
**CharArrayReader**
(char\[\] buf, int offset, int length)

Creates a CharArrayReader from the specified array of chars.

The resulting reader will start reading at the given
offset. The total number of char values that can be
read from this reader will be either length or
buf.length-offset, whichever is smaller.

##### Parameters

| buf | Input buffer (not copied) |
| offset | Offset of the first char to read |
| length | Number of chars to read |
|---|---|

##### Throws

| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | If offset is negative or greater than buf.length, or if length is negative, or if the sum of these two values is negative. |
|---|---|

## 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(), reset(), or skip() 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 character array, there is no actual limit; hence this argument is ignored. |
|---|---|

##### Throws

| [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, as an integer in the range 0 to 65535 (0x00-0xffff), 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\[\] b, int off, int len)

Reads characters into a portion of an array.

##### Parameters

| b | Destination buffer |
| off | Offset at which to start storing characters |
| len | Maximum number of characters to read |
|---|---|

##### Returns

- The actual 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. Character-array readers
are always ready to be read.

##### Returns

- True if the next read() is guaranteed not to block for input, false otherwise. Note that returning false does not guarantee that the next read will block.

##### Throws

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

#### public void
**reset**
()

Resets the stream to the most recent mark, or to the beginning 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 n)

Skips characters. Returns the number of characters that were skipped.

The `n` 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. If `n` is negative, then
this method does nothing and returns `0`.

##### Parameters

| n | 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 the stream is closed, or an I/O error occurs |
|---|---|