Added in API level 1

Summary: Fields | Inherited Fields | Ctors | Methods | Inherited Methods

CharArrayReader

public class CharArrayReader
extends Reader

java.lang.Object
↳	java.io.Reader
	↳	java.io.CharArrayReader

This class implements a character buffer that can be used as a character-input stream.

Summary

Fields
`protected char[]`	`buf` The character buffer.
`protected int`	`count` The index of the end of this buffer.
`protected int`	`markedPos` The position of mark in buffer.
`protected int`	`pos` The current buffer position.

Inherited fields

From class java.io.Reader


    protected
    
    
    Object

lock

The object used to synchronize operations on this stream.

Public constructors
`CharArrayReader(char[] buf)` Creates a CharArrayReader from the specified array of chars.
`CharArrayReader(char[] buf, int offset, int length)` Creates a CharArrayReader from the specified array of chars.

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.
`int`	`read(CharBuffer target)` Attempts to read characters into the specified character buffer.
`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 if it has never been marked.
`long`	`skip(long n)` Skips characters.

Inherited methods

From class


        
          java.io.Reader

`abstract 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.
`static Reader`	`nullReader()` Returns a new `Reader` that reads no characters.
`int`	`read()` Reads a single character.
`abstract int`	`read(char[] cbuf, int off, int len)` Reads characters into a portion of an array.
`int`	`read(char[] cbuf)` Reads characters into an array.
`int`	`read(CharBuffer target)` Attempts to read characters into the specified character buffer.
`boolean`	`ready()` Tells whether this stream is ready to be read.
`void`	`reset()` Resets the stream.
`long`	`skip(long n)` Skips characters.
`long`	`transferTo(Writer out)` Reads all characters from this reader and writes the characters to the given writer in the order that they are read.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          java.lang.Readable


      read(CharBuffer cb)

Attempts to read characters into the specified character buffer.

From interface


        
          java.io.Closeable


      close()

Closes this stream and releases any system resources associated with it.

From interface


        
          java.lang.AutoCloseable


      close()

Closes this resource, relinquishing any underlying resources.

Fields

buf

Added in API level 1

protected char[] buf

The character buffer.

count

Added in API level 1

protected int count

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

markedPos

Added in API level 1

protected int markedPos

The position of mark in buffer.

pos

Added in API level 1

protected int pos

The current buffer position.

Public constructors

CharArrayReader

Added in API level 1

public CharArrayReader (char[] buf)

Creates a CharArrayReader from the specified array of chars.

Parameters
`buf`	`char`: Input buffer (not copied)

CharArrayReader

Added in API level 1

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`	`char`: Input buffer (not copied)
`offset`	`int`: Offset of the first char to read
`length`	`int`: Number of chars to read

Throws
`IllegalArgumentException`	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

close

Added in API level 1

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. This method will block while there is another thread blocking on the reader.

mark

Added in API level 1

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`	`int`: 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`	If an I/O error occurs

markSupported

Added in API level 1

public 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

public int read ()

Reads a single character.

Returns
`int`	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`	If an I/O error occurs

read

Added in API level 1

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

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`:
`off`	`int`:
`len`	`int`:

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

Throws
`IndexOutOfBoundsException`
`IOException`

read

Added in API level 1

public int read (CharBuffer target)

Attempts to read characters into the specified character buffer. The buffer is used as a repository of characters as-is: the only changes made are the results of a put operation. No flipping or rewinding of the buffer is performed.

Parameters
`target`	`CharBuffer`: the buffer to read characters into

Returns
`int`	The number of characters added to the buffer, or -1 if this source of characters is at its end

Throws
`IOException`

ready

Added in API level 1

public boolean ready ()

Tells whether this stream is ready to be read. Character-array readers are always ready to be read.

Returns
`boolean`	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`	If an I/O error occurs

reset

Added in API level 1

public void reset ()

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

Throws
`IOException`	If an I/O error occurs

skip

Added in API level 1

public long skip (long n)

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

Parameters
`n`	`long`:

Returns
`long`	The number of characters actually skipped

Throws
`IOException`