Class ByteArrayInputStream
- java.lang.Object
-
- java.io.InputStream
-
- java.io.ByteArrayInputStream
-
- All Implemented Interfaces:
- Closeable, AutoCloseable
public class ByteArrayInputStream extends InputStream
AByteArrayInputStream
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 theread
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:
- JDK1.0
- See Also:
-
StringBufferInputStream
-
-
Field Summary
Fields Modifier and Type Field and Description protected byte[]
buf
An array of bytes that was provided by the creator of the stream.protected int
count
The index one greater than the last valid character in the input stream buffer.protected int
mark
The currently marked position in the stream.protected int
pos
The index of the next character to read from the input stream buffer.
-
Constructor Summary
Constructors Constructor and Description ByteArrayInputStream(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
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description int
available()
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
markSupported()
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.void
reset()
Resets the buffer to the marked position.long
skip(long n)
Skipsn
bytes of input from this input stream.-
Methods inherited from class java.io.InputStream
read
-
-
-
-
Field Detail
buf
protected byte[] buf
An 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 pos
The index of the next character 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 mark
The 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:
- JDK1.1
count
protected int count
The index one greater than the last valid character 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 Detail
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 Detail
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 has been 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.This
read
method cannot block.- Overrides:
-
read
in classInputStream
- Parameters:
-
b
- the buffer into which the data is read. -
off
- the start offset in the destination arrayb
-
len
- the maximum number of bytes 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:
-
InputStream.read()
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.
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. ThemarkSupported
method ofByteArrayInputStream
always returnstrue
.- Overrides:
-
markSupported
in classInputStream
- Returns:
-
true
if this stream instance supports the mark and reset methods;false
otherwise. - Since:
- JDK1.1
- See Also:
-
InputStream.mark(int)
,InputStream.reset()
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:
- JDK1.1
- See Also:
-
InputStream.reset()
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:
-
InputStream.mark(int)
,IOException
close
public void close() throws IOException
Closing a ByteArrayInputStream has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.- Specified by:
-
close
in interfaceCloseable
- Specified by:
-
close
in interfaceAutoCloseable
- Overrides:
-
close
in classInputStream
- Throws:
-
IOException
- if an I/O error occurs.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.