All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.io.CharArrayReader

java.lang.Object
|
   +----java.io.Reader
|
           +----java.io.CharArrayReader

public class CharArrayReader
extends Reader
This class implements a character buffer that can be used as a character-input stream.


Variable Index

 o buf
Character buffer
 o count
Number of valid characters in buffer
 o markedPos
Position of mark in buffer
 o pos
Current buffer position

Constructor Index

 o CharArrayReader(char[])
Create an CharArrayReader from the specified array of chars.
 o CharArrayReader(char[], int, int)
Create an CharArrayReader from the specified array of chars.

Method Index

 o close()
Close the stream.
 o mark(int)
Mark the present position in the stream.
 o markSupported()
Tell whether this stream supports the mark() operation, which it does.
 o read()
Read a single character.
 o read(char[], int, int)
Read characters into a portion of an array.
 o ready()
Tell whether this stream is ready to be read.
 o reset()
Reset the stream to the most recent mark, or to the beginning if it has never been marked.
 o skip(long)
Skip characters.

Variables

 o buf
protected char buf[]
Character buffer

 o pos
protected int pos
Current buffer position

 o markedPos
protected int markedPos
Position of mark in buffer

 o count
protected int count
Number of valid characters in buffer

Constructors

 o CharArrayReader
public CharArrayReader(char buf[])
Create an CharArrayReader from the specified array of chars.

Parameters:
buf - Input buffer (not copied)
 o CharArrayReader
public CharArrayReader(char buf[],
                        int offset,
                        int length)
Create an CharArrayReader from the specified array of chars.

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

Methods

 o read
public int read() throws IOException
Read a single character.

Throws: IOException
If an I/O error occurs
Overrides:
read in class Reader
 o read
public int read(char b[],
                 int off,
                 int len) throws IOException
Read 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
If an I/O error occurs
Overrides:
read in class Reader
 o skip
public long skip(long n) throws IOException
Skip characters.

Parameters:
n - The number of characters to skip
Returns:
The number of characters actually skipped
Throws: IOException
If an I/O error occurs
Overrides:
skip in class Reader
 o ready
public boolean ready() throws IOException
Tell whether this stream is ready to be read. Character-array readers are always ready to be read.

Throws: IOException
If an I/O error occurs
Overrides:
ready in class Reader
 o markSupported
public boolean markSupported()
Tell whether this stream supports the mark() operation, which it does.

Overrides:
markSupported in class Reader
 o mark
public void mark(int readAheadLimit) throws IOException
Mark 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
If an I/O error occurs
Overrides:
mark in class Reader
 o reset
public void reset() throws IOException
Reset 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
Overrides:
reset in class Reader
 o close
public void close()
Close the stream.

Overrides:
close in class Reader

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Submit a bug or feature - Version 1.1.8 of Java Platform API Specification
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1995-1999 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.