Build 1.0_r1(from source)

java.io
Class CharArrayReader

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

public class CharArrayReader
extends Reader

CharArrayReader is used as a buffered character input stream on a character array.


Field Summary
protected  char[] buf
          Buffer for characters
protected  int count
          The ending index of the buffer.
protected  int markedPos
          Current mark position.
protected  int pos
          Current buffer position.
 
Fields inherited from class java.io.Reader
lock
 
Constructor Summary
CharArrayReader(char[] buf)
          Construct a CharArrayReader on the char array buffer.
CharArrayReader(char[] buf, int offset, int length)
          Construct a CharArrayReader on the char array buffer.
 
Method Summary
 void close()
          This method closes this CharArrayReader.
 void mark(int readLimit)
          Set a Mark position in this Reader.
 boolean markSupported()
          Returns a boolean indicating whether or not this CharArrayReader supports mark() and reset().
 int read()
          Reads a single character from this CharArrayReader and returns the result as an int.
 int read(char[] buffer, int offset, int len)
          Reads at most count characters from this CharArrayReader and stores them at offset in the character array buf.
 boolean ready()
          Returns a boolean indicating whether or not this CharArrayReader is ready to be read without blocking.
 void reset()
          Reset this CharArrayReader's position to the last mark() location.
 long skip(long n)
          Skips count number of characters in this CharArrayReader.
 
Methods inherited from class java.io.Reader
read, read
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

buf

protected char[] buf
Buffer for characters


pos

protected int pos
Current buffer position.


markedPos

protected int markedPos
Current mark position.


count

protected int count
The ending index of the buffer.

Constructor Detail

CharArrayReader

public CharArrayReader(char[] buf)
Construct a CharArrayReader on the char array buffer. The size of the reader is set to the length() of the buffer and the Object to synchronize access through is set to buffer.

Parameters:
buf - the char array to filter reads on.

CharArrayReader

public CharArrayReader(char[] buf,
                       int offset,
                       int length)
Construct a CharArrayReader on the char array buffer. The size of the reader is set to the parameter length() and the original offset is set to offset.

Parameters:
buf - the char array to filter reads on.
offset - the offset in buf to start streaming at.
length - the number of characters available to stream over.
Method Detail

close

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

Specified by:
close in interface Closeable
Specified by:
close in class Reader

mark

public void mark(int readLimit)
          throws IOException
Set a Mark position in this Reader. The parameter readLimit is ignored for CharArrayReaders. Sending reset() will reposition the reader back to the marked position provided the mark has not been invalidated.

Overrides:
mark in class Reader
Parameters:
readLimit - ignored for CharArrayReaders.
Throws:
IOException - If an error occurs attempting to mark this CharArrayReader.

markSupported

public boolean markSupported()
Returns a boolean indicating whether or not this CharArrayReader supports mark() and reset(). This method always returns true.

Overrides:
markSupported in class Reader
Returns:
indicates whether or not mark() and reset() are supported.

read

public int read()
         throws IOException
Reads a single character from this CharArrayReader and returns the result as an int. The 2 higher-order bytes are set to 0. If the end of reader was encountered then return -1.

Overrides:
read in class Reader
Returns:
int the character read or -1 if end of reader.
Throws:
IOException - If the CharArrayReader is already closed.

read

public int read(char[] buffer,
                int offset,
                int len)
         throws IOException
Reads at most count characters from this CharArrayReader and stores them at offset in the character array buf. Returns the number of characters actually read or -1 if the end of reader was encountered.

Specified by:
read in class Reader
Parameters:
buffer - character array to store the read characters
offset - offset in buf to store the read characters
len - maximum number of characters to read
Returns:
number of characters read or -1 if end of reader.
Throws:
IOException - If the CharArrayReader is closed.

ready

public boolean ready()
              throws IOException
Returns a boolean indicating whether or not this CharArrayReader is ready to be read without blocking. If the result is true, the next read() will not block. If the result is false this Reader may or may not block when read() is sent. The implementation in CharArrayReader always returns true even when it has been closed.

Overrides:
ready in class Reader
Returns:
true if the receiver will not block when read() is called, false if unknown or blocking will occur.
Throws:
IOException - If the CharArrayReader is closed.

reset

public void reset()
           throws IOException
Reset this CharArrayReader's position to the last mark() location. Invocations of read()/skip() will occur from this new location. If this Reader was not marked, the CharArrayReader is reset to the beginning of the String.

Overrides:
reset in class Reader
Throws:
IOException - If this CharArrayReader has already been closed.

skip

public long skip(long n)
          throws IOException
Skips count number of characters in this CharArrayReader. Subsequent read()'s will not return these characters unless reset() is used.

Overrides:
skip in class Reader
Parameters:
n - The number of characters to skip.
Returns:
long The number of characters actually skipped.
Throws:
IOException - If this CharArrayReader has already been closed.

Build 1.0_r1(from source)

Please submit a feedback, bug or feature