java.io.InputStream
|
FlexDoc/Javadoc 2.0 Demo Java Doc |
|||||||||||||||
java.io.ByteArrayInputStreamClosing a ByteArrayInputStream has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.
Field Summary |
||
protected byte[] |
An array of bytes that was provided
by the creator of the stream.
|
|
protected int |
The index one greater than the last valid character in the input
stream buffer.
|
|
protected int |
The currently marked position in the stream.
|
|
protected int |
The index of the next character to read from the input stream buffer.
|
|
Constructor Summary |
||
|
ByteArrayInputStream(byte[] buf)
Creates a ByteArrayInputStream
so that it uses buf as its
buffer array.
|
||
|
ByteArrayInputStream(byte[] buf, int offset, int length)
Creates ByteArrayInputStream
that uses buf as its
buffer array.
|
Method Summary |
||
int |
Returns the number of remaining bytes that can be read (or skipped over)
from this input stream.
|
|
void |
close()
Closing a ByteArrayInputStream has no effect.
|
|
void |
mark(int readAheadLimit)
Set the current marked position in the stream.
|
|
boolean |
Tests if this InputStream supports mark/reset.
|
|
int |
read()
Reads the next byte of data from this input stream.
|
|
int |
read(byte[] b, int off, int len)
Reads up to len bytes of data into an array of bytes from this
input stream.
|
|
byte[] |
Reads all remaining bytes from the input stream.
|
|
int |
readNBytes(byte[] b, int off, int len)
Reads the requested number of bytes from the input stream into the given
byte array.
|
|
void |
reset()
Resets the buffer to the marked position.
|
|
long |
skip(long n)
Skips n bytes of input from this input stream.
|
|
long |
transferTo(OutputStream out)
Reads all bytes from this input stream and writes the bytes to the
given output stream in the order that they are read.
|
|
Methods inherited from class java.io.InputStream |
Methods inherited from class java.lang.Object |
If no mark has been set, then the value of mark is the offset passed to the constructor (or 0 if the offset was not supplied).
public ByteArrayInputStream |
(byte[] buf) |
public ByteArrayInputStream |
(byte[] buf, int offset, int length) |
public int read |
() |
This read method cannot block.
public int read |
(byte[] b, int off, int len) |
Unlike the overridden method of InputStream, this method returns -1 instead of zero if the end of the stream has been reached and len == 0.
This read method cannot block.
public byte[] readAllBytes |
() |
When this stream reaches end of stream, further invocations of this method will return an empty byte array.
Note that this method is intended for simple cases where it is convenient to read all bytes into a byte array. It is not intended for reading input streams with large amounts of data.
The behavior for the case where the input stream is asynchronously closed, or the thread interrupted during the read, is highly input stream specific, and therefore not specified.
If an I/O error occurs reading from the input stream, then it may do so after some, but not all, bytes have been read. Consequently the input stream may not be at end of stream and may be in an inconsistent state. It is strongly recommended that the stream be promptly closed if an I/O error occurs.
public int readNBytes |
(byte[] b, int off, int len) |
In the case where end of stream is reached before len bytes have been read, then the actual number of bytes read will be returned. When this stream reaches end of stream, further invocations of this method will return zero.
If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read up to len bytes.
The first byte read is stored into element b[off], the next one in to b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k ] through b[off+len-1] unaffected.
The behavior for the case where the input stream is asynchronously closed, or the thread interrupted during the read, is highly input stream specific, and therefore not specified.
If an I/O error occurs reading from the input stream, then it may do so after some, but not all, bytes of b have been updated with data from the input stream. Consequently the input stream and b may be in an inconsistent state. It is strongly recommended that the stream be promptly closed if an I/O error occurs.
public long transferTo |
(OutputStream out) |
throws |
This method may block indefinitely reading from the input stream, or writing to the output stream. The behavior for the case where the input and/or output stream is asynchronously closed, or the thread interrupted during the transfer, is highly input and output stream specific, and therefore not specified.
If an I/O error occurs reading from the input stream or writing to the output stream, then it may do so after some bytes have been read or written. Consequently the input stream may not be at end of stream and one, or both, streams may be in an inconsistent state. It is strongly recommended that both streams be promptly closed if an I/O error occurs.
public long skip |
(long n) |
public int available |
() |
The value returned is count - pos, which is the number of bytes remaining to be read from the input buffer.
public boolean markSupported |
() |
public void mark |
(int readAheadLimit) |
If no mark has been set, then the value of the mark is the offset passed to the constructor (or 0 if the offset was not supplied).
Note: The readAheadLimit for this class has no meaning.
public void reset |
() |
public void close |
() |
throws |
|
FlexDoc/Javadoc 2.0 Demo Java Doc |
|||||||||||||||