Apache Commons Compress 1.26.0 · org.apache.commons.compress.utils.BoundedArchiveInputStream

Modifier and Type	Field and Description
private final long	end
private long	loc
private ByteBuffer	singleByteBuffer

Access	Constructor and Description
public	BoundedArchiveInputStream(final long position in the stream from where the reading of this bounded stream starts. start, final long amount of bytes which are allowed to read from the bounded stream. remaining) Constructs a new bounded input stream.

Method Summary

Modifier and Type	Method and Description
public synchronized int	read() Implements abstract java.io.InputStream.read. Reads the next byte of data from the input stream.
public synchronized int	read(final byte[] the buffer into which the data is read. b, final int the start offset in array `b` at which the data is written. off, final int the maximum number of bytes to read. len) Overrides java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes.
protected abstract int	Returns: number of read bytes. read(long position to start the read. pos, ByteBuffer buffer to add the read content. buf) Reads content of the stream into a `ByteBuffer`.

Inherited from java.io.InputStream:: available close mark markSupported nullInputStream read readAllBytes readNBytes readNBytes reset skip skipNBytes transferTo

end	back to summary
private final long end

loc	back to summary
private long loc

singleByteBuffer	back to summary
private ByteBuffer singleByteBuffer

BoundedArchiveInputStream	back to summary
public BoundedArchiveInputStream(final long start, final long remaining) Constructs a new bounded input stream. Parameters start:long position in the stream from where the reading of this bounded stream starts. remaining:long amount of bytes which are allowed to read from the bounded stream.

Method Detail

read back to summary

read	back to summary
public synchronized int read() throws IOException Implements abstract java.io.InputStream.read. Doc from java.io.InputStream.read. Reads the next byte of data from the input stream. The value byte is returned as an `int` in the range `0` to `255`. If no byte is available because the end of the stream has been reached, the value `-1` is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown. Returns:int the next byte of data, or `-1` if the end of the stream is reached. Annotations @Override Exceptions IOException: if an I/O error occurs.

public synchronized int read() throws IOException

Implements abstract java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Returns:int

the next byte of data, or -1 if the end of the stream is reached.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public synchronized int read(final byte[] b, final int off, final int len) throws IOException Overrides java.io.InputStream.read. Doc from java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes. An attempt is made to read as many as `len` bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown. If `len` is zero, then no bytes are read and `0` is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value `-1` is returned; otherwise, at least one byte is read and stored into `b`. The first byte read is stored into element `b[off]`, the next one into `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. In every case, elements `b[0]` through `b[off-1]` and elements `b[off+len]` through `b[b.length-1]` are unaffected. Parameters b:byte[] the buffer into which the data is read. off:int the start offset in array `b` at which the data is written. len:int the maximum number of bytes to read. Returns:int 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. Annotations @Override Exceptions IOException: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

public synchronized int read(final byte[] b, final int off, final int len) throws IOException

Overrides java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer.

This method blocks until input data is available, end of file is detected, or an exception is thrown.

If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[off], the next one into 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.

In every case, elements b[0] through b[off-1] and elements b[off+len] through b[b.length-1] are unaffected.

Parameters

b:byte[]: the buffer into which the data is read.
off:int: the start offset in array b at which the data is written.
len:int: the maximum number of bytes to read.

Returns:int

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.

Annotations

@Override

Exceptions

IOException:: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

read back to summary

read	back to summary
protected abstract int read(long pos, ByteBuffer buf) throws IOException Reads content of the stream into a `ByteBuffer`. Parameters pos:long position to start the read. buf:ByteBuffer buffer to add the read content. Returns:int number of read bytes. Exceptions IOException: if I/O fails.

protected abstract int read(long pos, ByteBuffer buf) throws IOException

Reads content of the stream into a ByteBuffer.

Parameters

pos:long: position to start the read.
buf:ByteBuffer: buffer to add the read content.

Returns:int

number of read bytes.

Exceptions

IOException:: if I/O fails.

public abstract Class BoundedArchiveInputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail