Class ByteArrayInputStream
- All Implemented Interfaces:
Closeable
,AutoCloseable
ByteArrayInputStream
contains
an internal buffer that contains bytes that
may be read from the stream. An internal
counter keeps track of the next byte to
be supplied by the read
method.
Closing a ByteArrayInputStream
has no effect. The methods in
this class can be called after the stream has been closed without
generating an IOException
.
- Since:
- 1.0
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected byte[]
An array of bytes that was provided by the creator of the stream.protected int
The index one greater than the last valid byte in the input stream buffer.protected int
The currently marked position in the stream.protected int
The index of the next byte to read from the input stream buffer. -
Constructor Summary
ConstructorDescriptionByteArrayInputStream
(byte[] buf) Creates aByteArrayInputStream
so that it usesbuf
as its buffer array.ByteArrayInputStream
(byte[] buf, int offset, int length) CreatesByteArrayInputStream
that usesbuf
as its buffer array. -
Method Summary
Modifier and TypeMethodDescriptionint
Returns the number of remaining bytes that can be read (or skipped over) from this input stream.void
close()
Closing aByteArrayInputStream
has no effect.void
mark
(int readAheadLimit) Set the current marked position in the stream.boolean
Tests if thisInputStream
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 tolen
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) Skipsn
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
nullInputStream, read, readNBytes, skipNBytes
-
Field Details
-
buf
protected byte[] bufAn array of bytes that was provided by the creator of the stream. Elementsbuf[0]
throughbuf[count-1]
are the only bytes that can ever be read from the stream; elementbuf[pos]
is the next byte to be read. -
pos
protected int posThe index of the next byte to read from the input stream buffer. This value should always be nonnegative and not larger than the value ofcount
. The next byte to be read from the input stream buffer will bebuf[pos]
. -
mark
protected int markThe currently marked position in the stream. ByteArrayInputStream objects are marked at position zero by default when constructed. They may be marked at another position within the buffer by themark()
method. The current buffer position is set to this point by thereset()
method.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).
- Since:
- 1.1
-
count
protected int countThe index one greater than the last valid byte in the input stream buffer. This value should always be nonnegative and not larger than the length ofbuf
. It is one greater than the position of the last byte withinbuf
that can ever be read from the input stream buffer.
-
-
Constructor Details
-
ByteArrayInputStream
public ByteArrayInputStream(byte[] buf) Creates aByteArrayInputStream
so that it usesbuf
as its buffer array. The buffer array is not copied. The initial value ofpos
is0
and the initial value ofcount
is the length ofbuf
.- Parameters:
buf
- the input buffer.
-
ByteArrayInputStream
public ByteArrayInputStream(byte[] buf, int offset, int length) CreatesByteArrayInputStream
that usesbuf
as its buffer array. The initial value ofpos
isoffset
and the initial value ofcount
is the minimum ofoffset+length
andbuf.length
. The buffer array is not copied. The buffer's mark is set to the specified offset.- Parameters:
buf
- the input buffer.offset
- the offset in the buffer of the first byte to read.length
- the maximum number of bytes to read from the buffer.
-
-
Method Details
-
read
public int read()Reads the next byte of data from this input stream. The value byte is returned as anint
in the range0
to255
. If no byte is available because the end of the stream has been reached, the value-1
is returned.This
read
method cannot block.- Specified by:
read
in classInputStream
- Returns:
- the next byte of data, or
-1
if the end of the stream is reached.
-
read
public int read(byte[] b, int off, int len) Reads up tolen
bytes of data into an array of bytes from this input stream. Ifpos
equalscount
, then-1
is returned to indicate end of file. Otherwise, the numberk
of bytes read is equal to the smaller oflen
andcount-pos
. Ifk
is positive, then bytesbuf[pos]
throughbuf[pos+k-1]
are copied intob[off]
throughb[off+k-1]
in the manner performed bySystem.arraycopy
. The valuek
is added intopos
andk
is returned.Unlike the
overridden method
ofInputStream
, this method returns-1
instead of zero if the end of the stream has been reached andlen == 0
.This
read
method cannot block.- Overrides:
read
in classInputStream
- Parameters:
b
- the buffer into which the data is read.off
- the start offset in arrayb
at which the data is written.len
- the maximum number of bytes to read.- Returns:
- the total number of bytes read into the buffer, or
-1
if there is no more data because the end of the stream has been reached. - Throws:
NullPointerException
- Ifb
isnull
.IndexOutOfBoundsException
- Ifoff
is negative,len
is negative, orlen
is greater thanb.length - off
- See Also:
-
readAllBytes
public byte[] readAllBytes()Description copied from class:InputStream
Reads all remaining bytes from the input stream. This method blocks until all remaining bytes have been read and end of stream is detected, or an exception is thrown. This method does not close the input stream.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.
- Overrides:
readAllBytes
in classInputStream
- Returns:
- a byte array containing the bytes read from this input stream
-
readNBytes
public int readNBytes(byte[] b, int off, int len) Description copied from class:InputStream
Reads the requested number of bytes from the input stream into the given byte array. This method blocks untillen
bytes of input data have been read, end of stream is detected, or an exception is thrown. The number of bytes actually read, possibly zero, is returned. This method does not close the input stream.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 and0
is returned; otherwise, there is an attempt to read up tolen
bytes.The first byte read is stored into element
b[off]
, the next one in tob[off+1]
, and so on. The number of bytes read is, at most, equal tolen
. Let k be the number of bytes actually read; these bytes will be stored in elementsb[off]
throughb[off+
k-1]
, leaving elementsb[off+
k]
throughb[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 andb
may be in an inconsistent state. It is strongly recommended that the stream be promptly closed if an I/O error occurs.- Overrides:
readNBytes
in classInputStream
- Parameters:
b
- the byte array into which the data is readoff
- the start offset inb
at which the data is writtenlen
- the maximum number of bytes to read- Returns:
- the actual number of bytes read into the buffer
-
transferTo
Description copied from class:InputStream
Reads all bytes from this input stream and writes the bytes to the given output stream in the order that they are read. On return, this input stream will be at end of stream. This method does not close either stream.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 the total number of bytes transferred is greater than Long.MAX_VALUE, then
Long.MAX_VALUE
will be returned.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.
- Overrides:
transferTo
in classInputStream
- Parameters:
out
- the output stream, non-null- Returns:
- the number of bytes transferred
- Throws:
IOException
- if an I/O error occurs when reading or writing
-
skip
public long skip(long n) Skipsn
bytes of input from this input stream. Fewer bytes might be skipped if the end of the input stream is reached. The actual numberk
of bytes to be skipped is equal to the smaller ofn
andcount-pos
. The valuek
is added intopos
andk
is returned.- Overrides:
skip
in classInputStream
- Parameters:
n
- the number of bytes to be skipped.- Returns:
- the actual number of bytes skipped.
- See Also:
-
available
public int available()Returns the number of remaining bytes that can be read (or skipped over) from this input stream.The value returned is
count - pos
, which is the number of bytes remaining to be read from the input buffer.- Overrides:
available
in classInputStream
- Returns:
- the number of remaining bytes that can be read (or skipped over) from this input stream without blocking.
-
markSupported
public boolean markSupported()Tests if thisInputStream
supports mark/reset.- Overrides:
markSupported
in classInputStream
- Implementation Requirements:
- The
markSupported
method ofByteArrayInputStream
always returnstrue
. - Returns:
- true
- Since:
- 1.1
- See Also:
-
mark
public void mark(int readAheadLimit) Set the current marked position in the stream. ByteArrayInputStream objects are marked at position zero by default when constructed. They may be marked at another position within the buffer by this method.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.- Overrides:
mark
in classInputStream
- Parameters:
readAheadLimit
- the maximum limit of bytes that can be read before the mark position becomes invalid.- Since:
- 1.1
- See Also:
-
reset
public void reset()Resets the buffer to the marked position. The marked position is 0 unless another position was marked or an offset was specified in the constructor.- Overrides:
reset
in classInputStream
- See Also:
-
close
Closing aByteArrayInputStream
has no effect. The methods in this class can be called after the stream has been closed without generating anIOException
.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classInputStream
- Throws:
IOException
- if an I/O error occurs.
-