|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.io.Reader
java.io.CharArrayReader
public class CharArrayReader
This class permits an array of chars to be read as an input stream.
Field Summary | |
---|---|
protected char[] |
buf
The array that contains the data supplied during read operations |
protected int |
count
This indicates the maximum number of chars that can be read from this stream. |
protected int |
markedPos
The currently marked position in the stream. |
protected int |
pos
The array index of the next char to be read from the buffer buf |
Fields inherited from class java.io.Reader |
---|
lock |
Constructor Summary | |
---|---|
CharArrayReader(char[] buffer)
Create a new CharArrayReader that will read chars from the passed in char array. |
|
CharArrayReader(char[] buffer,
int offset,
int length)
Create a new CharArrayReader that will read chars from the passed in char array. |
Method Summary | |
---|---|
void |
close()
This method closes the stream. |
void |
mark(int readAheadLimit)
This method sets the mark position in this stream to the current position. |
boolean |
markSupported()
This method overrides the markSupported method in
Reader in order to return true -
indicating that this stream class supports mark/reset
functionality. |
int |
read()
This method reads one char from the stream. |
int |
read(char[] b,
int off,
int len)
This method reads chars from the stream and stores them into a caller supplied buffer. |
boolean |
ready()
Return true if more characters are available to be read. |
void |
reset()
This method sets the read position in the stream to the mark point by setting the pos variable equal to the
mark variable. |
long |
skip(long n)
This method attempts to skip the requested number of chars in the input stream. |
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 |
---|
protected char[] buf
protected int pos
buf
protected int markedPos
protected int count
buf
Constructor Detail |
---|
public CharArrayReader(char[] buffer)
CharArrayReader(buf, 0, buf.length)
.
Note that this array is not copied. If its contents are changed while this stream is being read, those changes will be reflected in the chars supplied to the reader. Please use caution in changing the contents of the buffer while this stream is open.
buffer
- The char array buffer this stream will read from.public CharArrayReader(char[] buffer, int offset, int length)
offset
in the array for a length of
length
chars past offset
. If the
stream is reset to a position before offset
then
more than length
chars can be read from the stream.
The length
value should be viewed as the array index
one greater than the last position in the buffer to read.
Note that this array is not copied. If its contents are changed while this stream is being read, those changes will be reflected in the chars supplied to the reader. Please use caution in changing the contents of the buffer while this stream is open.
buffer
- The char array buffer this stream will read from.offset
- The index into the buffer to start reading chars fromlength
- The number of chars to read from the bufferMethod Detail |
---|
public void close()
close
in interface Closeable
close
in class Reader
public void mark(int readAheadLimit) throws IOException
readlimit
parameter in this
method does nothing as this stream is always capable of
remembering all the chars int it.
Note that in this class the mark position is set by default to position 0 in the stream. This is in constrast to some other stream types where there is no default mark position.
mark
in class Reader
readAheadLimit
- The number of chars this stream must
remember. This parameter is ignored.
IOException
- If an error occurspublic boolean markSupported()
markSupported
method in
Reader
in order to return true
-
indicating that this stream class supports mark/reset
functionality.
markSupported
in class Reader
true
to indicate that this class supports
mark/reset.public int read() throws IOException
pos
counter is advanced to the next char to be read. The char read
is returned as an int in the range of 0-65535. If the stream
position is already at the end of the buffer, no char is read and
a -1 is returned in order to indicate the end of the stream.
read
in class Reader
IOException
- If an error occurspublic int read(char[] b, int off, int len) throws IOException
offset
into the buffer and attempts to read
len
chars. This method can return before reading
the number of chars requested if the end of the stream is
encountered first. The actual number of chars read is returned.
If no chars can be read because the stream is already at the end
of stream position, a -1 is returned.
This method does not block.
read
in class Reader
b
- The array into which the chars read should be stored.off
- The offset into the array to start storing charslen
- The requested number of chars to read
IOException
- If an error occurs.public boolean ready() throws IOException
ready
in class Reader
true
to indicate that this stream is ready
to be read.
IOException
- If an error occurspublic void reset() throws IOException
pos
variable equal to the
mark
variable. Since a mark can be set anywhere in
the array, the mark/reset methods int this class can be used to
provide random search capabilities for this type of stream.
reset
in class Reader
IOException
- Always thrown for this classpublic long skip(long n) throws IOException
pos
value by the
specified number of chars. It this would exceed the length of the
buffer, then only enough chars are skipped to position the stream at
the end of the buffer. The actual number of chars skipped is returned.
skip
in class Reader
n
- The requested number of chars to skip
IOException
- If an error occurs
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |