Skip to content

Most visited

Recently visited

navigation
Added in API level 1

CharArrayReader

public class CharArrayReader
extends Reader

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


A specialized Reader for reading the contents of a char array.

See also:

Summary

Fields

protected char[] buf

The buffer for characters.

protected int count

The ending index of the buffer.

protected int markedPos

The current mark position.

protected int pos

The current buffer position.

Inherited fields

From class java.io.Reader

Public constructors

CharArrayReader(char[] buf)

Constructs a CharArrayReader on the char array buf.

CharArrayReader(char[] buf, int offset, int length)

Constructs a CharArrayReader on the char array buf.

Public methods

void close()

This method closes this CharArrayReader.

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.

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

Reads up to count characters from this CharArrayReader 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)

Skips charCount characters in this reader.

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

Fields

buf

Added in API level 1
char[] buf

The buffer for characters.

count

Added in API level 1
int count

The ending index of the buffer.

markedPos

Added in API level 1
int markedPos

The current mark position.

pos

Added in API level 1
int pos

The current buffer position.

Public constructors

CharArrayReader

Added in API level 1
CharArrayReader (char[] buf)

Constructs a CharArrayReader on the char array buf. The size of the reader is set to the length of the buffer and the object to to read from is set to buf.

Parameters
buf char: the char array from which to read.

CharArrayReader

Added in API level 1
CharArrayReader (char[] buf, 
                int offset, 
                int length)

Constructs a CharArrayReader on the char array buf. The size of the reader is set to length and the start position from which to read the buffer is set to offset.

Parameters
buf char: the char array from which to read.
offset int: the index of the first character in buf to read.
length int: the number of characters that can be read from buf.
Throws
IllegalArgumentException if offset < 0 or length < 0, or if offset is greater than the size of buf .

Public methods

close

Added in API level 1
void close ()

This method closes this CharArrayReader. Once it is closed, you can no longer read from it. Only the first invocation of this method has any effect.

mark

Added in API level 1
void mark (int readLimit)

Sets a mark position in this reader. The parameter readLimit is ignored for CharArrayReaders. Calling reset() will reposition the reader back to the marked position provided the mark has not been invalidated.

Parameters
readLimit int: ignored for CharArrayReaders.
Throws
IOException if this reader is closed.

markSupported

Added in API level 1
boolean markSupported ()

Indicates whether this reader supports the mark() and reset() methods.

Returns
boolean true for CharArrayReader.

See also:

read

Added in API level 1
int read ()

Reads a single character from this reader and returns it as an integer with the two higher-order bytes set to 0. Returns -1 if no more characters are available from this reader.

Returns
int the character read as an int or -1 if the end of the reader has been reached.
Throws
IOException if this reader is closed.

read

Added in API level 1
int read (char[] buffer, 
                int offset, 
                int count)

Reads up to count characters from this CharArrayReader and stores them at offset in the character array buffer. Returns the number of characters actually read or -1 if the end of reader was encountered.

Parameters
buffer char
offset int
count int
Returns
int
Throws
IndexOutOfBoundsException if offset < 0 || count < 0 || offset + count > buffer.length.
IOException if this reader is closed.

ready

Added in API level 1
boolean ready ()

Indicates whether this reader is ready to be read without blocking. Returns true if the next read will not block. Returns false if this reader may or may not block when read is called. The implementation in CharArrayReader always returns true even when it has been closed.

Returns
boolean true if this reader will not block when read is called, false if unknown or blocking will occur.
Throws
IOException if this reader is closed.

reset

Added in API level 1
void reset ()

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

Throws
IOException if this reader is closed.

skip

Added in API level 1
long skip (long charCount)

Skips charCount characters in this reader. Subsequent calls to read will not return these characters unless reset is used. This method does nothing and returns 0 if charCount <= 0.

Parameters
charCount long
Returns
long the number of characters actually skipped.
Throws
IOException if this reader is closed.
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.