|
FlexDoc/Javadoc 2.0 Demo Java Doc |
Class CharArrayReader
java.io.CharArrayReader
All Implemented Interfaces:
public class CharArrayReader
This class implements a character buffer that can be used as a
character-input stream.
Since:
1.1
Author:
Herb Jellinek
Field Summary |
protected char[] |
The character buffer.
|
protected int |
The index of the end of this buffer.
|
protected int |
The position of mark in buffer.
|
protected int |
The current buffer position.
|
Fields inherited from class java.io. Reader |
|
Constructor Summary |
Creates a CharArrayReader from the specified array of chars.
|
Creates a CharArrayReader from the specified array of chars.
|
Method Summary |
void |
Closes the stream and releases any system resources associated with
it.
|
void |
Marks the present position in the stream.
|
boolean |
Tells whether this stream supports the mark() operation, which it does.
|
int |
Reads a single character.
|
int |
read(char[] cbuf, int off, int len)
Reads characters into a portion of an array.
|
int |
Attempts to read characters into the specified character buffer.
|
boolean |
Tells whether this stream is ready to be read.
|
void |
Resets the stream to the most recent mark, or to the beginning if it has
never been marked.
|
long |
Skips characters.
|
Methods inherited from class java.io. Reader |
|
Methods inherited from class java.lang. Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
protected char[] buf
The character buffer.
protected int pos
The current buffer position.
protected int markedPos
The position of mark in buffer.
protected int count
The index of the end of this buffer. There is not valid
data at or beyond this index.
public CharArrayReader |
(char[] buf) |
Creates a CharArrayReader from the specified array of chars.
Parameters:
buf - Input buffer (not copied)
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 - Input buffer (not copied)
offset - Offset of the first char to read
length - 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 int read |
() |
throws |
|
Reads a single character.
Overrides:
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:
public int read |
(char[] cbuf, int off, int len) |
throws |
|
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.
Overrides:
Parameters:
cbuf - Destination buffer
off - Offset at which to start storing characters
len - Maximum number of characters to read
Returns:
The number of characters read, or -1 if the end of the
stream has been reached
Throws:
Description copied from class:
Reader
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.
Specified by:
Overrides:
Parameters:
target - the buffer to read characters into
Returns:
The number of characters added to the buffer, or
-1 if this source of characters is at its end
Throws:
public long skip |
(long n) |
throws |
|
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.
Overrides:
Parameters:
n - The number of characters to skip
Returns:
The number of characters actually skipped
Throws:
public boolean ready |
() |
throws |
|
Tells whether this stream is ready to be read. Character-array readers
are always ready to be read.
Overrides:
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:
public boolean markSupported |
() |
Tells whether this stream supports the mark() operation, which it does.
Overrides:
Returns:
true if and only if this stream supports the mark operation.
public void mark |
(int readAheadLimit) |
throws |
|
Marks the present position in the stream. Subsequent calls to reset()
will reposition the stream to this point.
Overrides:
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:
public void reset |
() |
throws |
|
Resets the stream to the most recent mark, or to the beginning if it has
never been marked.
Overrides:
Throws:
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.
Specified by:
Overrides:
|
FlexDoc/Javadoc 2.0 Demo Java Doc |
FlexDoc/Javadoc is a template-driven programming tool for rapid development of any Javadoc-based Java API documentation generators (i.e. doclets). If you need to customize your Javadoc without writing a full-blown doclet from scratch,
FlexDoc/Javadoc may be the only tool able to help you! Find out more at
www.flexdoc.xyz