|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.io.InputStream
java.io.ByteArrayInputStream
public class ByteArrayInputStream
This class permits an array of bytes to be read as an input stream.
Field Summary | |
---|---|
protected byte[] |
buf
The array that contains the data supplied during read operations |
protected int |
count
This indicates the maximum number of bytes that can be read from this stream. |
protected int |
mark
The currently marked position in the stream. |
protected int |
pos
The array index of the next byte to be read from the buffer buf |
Constructor Summary | |
---|---|
ByteArrayInputStream(byte[] buffer)
Create a new ByteArrayInputStream that will read bytes from the passed in byte array. |
|
ByteArrayInputStream(byte[] buffer,
int offset,
int length)
Create a new ByteArrayInputStream that will read bytes from the passed in byte array. |
Method Summary | |
---|---|
int |
available()
This method returns the number of bytes available to be read from this stream. |
void |
mark(int readLimit)
This method sets the mark position in this stream to the current position. |
boolean |
markSupported()
This method overrides the markSupported method in
InputStream in order to return true -
indicating that this stream class supports mark/reset
functionality. |
int |
read()
This method reads one byte from the stream. |
int |
read(byte[] buffer,
int offset,
int length)
This method reads bytes from the stream and stores them into a caller supplied buffer. |
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 num)
This method attempts to skip the requested number of bytes in the input stream. |
Methods inherited from class java.io.InputStream |
---|
close, read |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected byte[] buf
protected int pos
buf
protected int mark
protected int count
buf
Constructor Detail |
---|
public ByteArrayInputStream(byte[] buffer)
ByteArrayInputStream(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 bytes supplied to the reader. Please use caution in changing the contents of the buffer while this stream is open.
buffer
- The byte array buffer this stream will read from.public ByteArrayInputStream(byte[] buffer, int offset, int length)
offset
in the array for a length of
length
bytes past offset
. If the
stream is reset to a position before offset
then
more than length
bytes 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 bytes supplied to the reader. Please use caution in changing the contents of the buffer while this stream is open.
buffer
- The byte array buffer this stream will read from.offset
- The index into the buffer to start reading bytes fromlength
- The number of bytes to read from the bufferMethod Detail |
---|
public int available()
count - pos
.
available
in class InputStream
public void mark(int readLimit)
readlimit
parameter in this
method does nothing as this stream is always capable of
remembering all the bytes 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 InputStream
readLimit
- The number of bytes this stream must remember.
This parameter is ignored.public boolean markSupported()
markSupported
method in
InputStream
in order to return true
-
indicating that this stream class supports mark/reset
functionality.
markSupported
in class InputStream
true
to indicate that this class supports
mark/reset.public int read()
pos
counter is advanced to the next byte to be read. The byte read is
returned as an int in the range of 0-255. If the stream position
is already at the end of the buffer, no byte is read and a -1 is
returned in order to indicate the end of the stream.
read
in class InputStream
public int read(byte[] buffer, int offset, int length)
offset
into the buffer and attempts to read
len
bytes. This method can return before reading
the number of bytes requested if the end of the stream is
encountered first. The actual number of bytes read is returned.
If no bytes 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 InputStream
buffer
- The array into which the bytes read should be stored.offset
- The offset into the array to start storing byteslength
- The requested number of bytes to read
public void reset()
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 InputStream
public long skip(long num)
pos
value by the specified number of bytes. It this would exceed the
length of the buffer, then only enough bytes are skipped to
position the stream at the end of the buffer. The actual number
of bytes skipped is returned.
skip
in class InputStream
num
- The requested number of bytes to skip
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |