java.io
Class CharArrayReader

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.io.Reader sample code for java.io.Reader definition code for java.io.Reader 
      extended by java.io.CharArrayReader
All Implemented Interfaces:
Closeable sample code for java.io.Closeable definition code for java.io.Closeable , Readable sample code for java.lang.Readable definition code for java.lang.Readable

public class CharArrayReader
extends Reader sample code for java.io.Reader definition code for java.io.Reader

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

Since:
JDK1.1

Field Summary
protected  char[] buf sample code for java.io.CharArrayReader.buf definition code for java.io.CharArrayReader.buf
          The character buffer.
protected  int count sample code for java.io.CharArrayReader.count definition code for java.io.CharArrayReader.count
          The index of the end of this buffer.
protected  int markedPos sample code for java.io.CharArrayReader.markedPos definition code for java.io.CharArrayReader.markedPos
          The position of mark in buffer.
protected  int pos sample code for java.io.CharArrayReader.pos definition code for java.io.CharArrayReader.pos
          The current buffer position.
 
Fields inherited from class java.io.Reader sample code for java.io.Reader definition code for java.io.Reader
lock sample code for java.io.Reader.lock definition code for java.io.Reader.lock
 
Constructor Summary
CharArrayReader sample code for java.io.CharArrayReader.CharArrayReader(char[]) definition code for java.io.CharArrayReader.CharArrayReader(char[]) (char[] buf)
          Create an CharArrayReader from the specified array of chars.
CharArrayReader sample code for java.io.CharArrayReader.CharArrayReader(char[], int, int) definition code for java.io.CharArrayReader.CharArrayReader(char[], int, int) (char[] buf, int offset, int length)
          Create an CharArrayReader from the specified array of chars.
 
Method Summary
 void close sample code for java.io.CharArrayReader.close() definition code for java.io.CharArrayReader.close() ()
          Close the stream.
 void mark sample code for java.io.CharArrayReader.mark(int) definition code for java.io.CharArrayReader.mark(int) (int readAheadLimit)
          Mark the present position in the stream.
 boolean markSupported sample code for java.io.CharArrayReader.markSupported() definition code for java.io.CharArrayReader.markSupported() ()
          Tell whether this stream supports the mark() operation, which it does.
 int read sample code for java.io.CharArrayReader.read() definition code for java.io.CharArrayReader.read() ()
          Read a single character.
 int read sample code for java.io.CharArrayReader.read(char[], int, int) definition code for java.io.CharArrayReader.read(char[], int, int) (char[] b, int off, int len)
          Read characters into a portion of an array.
 boolean ready sample code for java.io.CharArrayReader.ready() definition code for java.io.CharArrayReader.ready() ()
          Tell whether this stream is ready to be read.
 void reset sample code for java.io.CharArrayReader.reset() definition code for java.io.CharArrayReader.reset() ()
          Reset the stream to the most recent mark, or to the beginning if it has never been marked.
 long skip sample code for java.io.CharArrayReader.skip(long) definition code for java.io.CharArrayReader.skip(long) (long n)
          Skip characters.
 
Methods inherited from class java.io.Reader sample code for java.io.Reader definition code for java.io.Reader
read sample code for java.io.Reader.read(char[]) definition code for java.io.Reader.read(char[]) , read sample code for java.io.Reader.read(java.nio.CharBuffer) definition code for java.io.Reader.read(java.nio.CharBuffer)
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Field Detail

buf sample code for java.io.CharArrayReader.buf

protected char[] buf
The character buffer.


pos sample code for java.io.CharArrayReader.pos

protected int pos
The current buffer position.


markedPos sample code for java.io.CharArrayReader.markedPos

protected int markedPos
The position of mark in buffer.


count sample code for java.io.CharArrayReader.count

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

Constructor Detail

CharArrayReader sample code for java.io.CharArrayReader(char[]) definition code for java.io.CharArrayReader(char[])

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

Parameters:
buf - Input buffer (not copied)

CharArrayReader sample code for java.io.CharArrayReader(char[], int, int) definition code for java.io.CharArrayReader(char[], int, int)

public CharArrayReader(char[] buf,
                       int offset,
                       int length)
Create an 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 sample code for java.lang.IllegalArgumentException definition code for java.lang.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.
Method Detail

read sample code for java.io.CharArrayReader.read() definition code for java.io.CharArrayReader.read()

public int read()
         throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Read a single character.

Overrides:
read sample code for java.io.Reader.read() definition code for java.io.Reader.read() in class Reader sample code for java.io.Reader definition code for java.io.Reader
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 sample code for java.io.IOException definition code for java.io.IOException - If an I/O error occurs

read sample code for java.io.CharArrayReader.read(char[], int, int) definition code for java.io.CharArrayReader.read(char[], int, int)

public int read(char[] b,
                int off,
                int len)
         throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Read characters into a portion of an array.

Specified by:
read sample code for java.io.Reader.read(char[], int, int) definition code for java.io.Reader.read(char[], int, int) in class Reader sample code for java.io.Reader definition code for java.io.Reader
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 sample code for java.io.IOException definition code for java.io.IOException - If an I/O error occurs

skip sample code for java.io.CharArrayReader.skip(long) definition code for java.io.CharArrayReader.skip(long)

public long skip(long n)
          throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Skip characters. Returns the number of characters that were skipped.

The n parameter may be negative, even though the skip method of the Reader sample code for java.io.Reader definition code for java.io.Reader superclass throws an exception in this case. If n is negative, then this method does nothing and returns 0.

Overrides:
skip sample code for java.io.Reader.skip(long) definition code for java.io.Reader.skip(long) in class Reader sample code for java.io.Reader definition code for java.io.Reader
Parameters:
n - The number of characters to skip
Returns:
The number of characters actually skipped
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - If the stream is closed, or an I/O error occurs

ready sample code for java.io.CharArrayReader.ready() definition code for java.io.CharArrayReader.ready()

public boolean ready()
              throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Tell whether this stream is ready to be read. Character-array readers are always ready to be read.

Overrides:
ready sample code for java.io.Reader.ready() definition code for java.io.Reader.ready() in class Reader sample code for java.io.Reader definition code for java.io.Reader
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 sample code for java.io.IOException definition code for java.io.IOException - If an I/O error occurs

markSupported sample code for java.io.CharArrayReader.markSupported() definition code for java.io.CharArrayReader.markSupported()

public boolean markSupported()
Tell whether this stream supports the mark() operation, which it does.

Overrides:
markSupported sample code for java.io.Reader.markSupported() definition code for java.io.Reader.markSupported() in class Reader sample code for java.io.Reader definition code for java.io.Reader
Returns:
true if and only if this stream supports the mark operation.

mark sample code for java.io.CharArrayReader.mark(int) definition code for java.io.CharArrayReader.mark(int)

public void mark(int readAheadLimit)
          throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Mark the present position in the stream. Subsequent calls to reset() will reposition the stream to this point.

Overrides:
mark sample code for java.io.Reader.mark(int) definition code for java.io.Reader.mark(int) in class Reader sample code for java.io.Reader definition code for java.io.Reader
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 sample code for java.io.IOException definition code for java.io.IOException - If an I/O error occurs

reset sample code for java.io.CharArrayReader.reset() definition code for java.io.CharArrayReader.reset()

public void reset()
           throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Reset the stream to the most recent mark, or to the beginning if it has never been marked.

Overrides:
reset sample code for java.io.Reader.reset() definition code for java.io.Reader.reset() in class Reader sample code for java.io.Reader definition code for java.io.Reader
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - If an I/O error occurs

close sample code for java.io.CharArrayReader.close() definition code for java.io.CharArrayReader.close()

public void close()
Close the stream.

Specified by:
close sample code for java.io.Closeable.close() definition code for java.io.Closeable.close() in interface Closeable sample code for java.io.Closeable definition code for java.io.Closeable
Specified by:
close sample code for java.io.Reader.close() definition code for java.io.Reader.close() in class Reader sample code for java.io.Reader definition code for java.io.Reader