public class CBZip2InputStream extends InputStream implements BZip2Constants
The decompression requires large amounts of memory. Thus you
should call the close()
method as soon as
possible, to force CBZip2InputStream to release the
allocated memory. See CBZip2OutputStream
for information about memory usage.
CBZip2InputStream reads bytes from the compressed
source stream via the single byte read()
method exclusively. Thus you should consider to use a
buffered source stream.
Instances of this class are not threadsafe.
baseBlockSize, G_SIZE, MAX_ALPHA_SIZE, MAX_CODE_LEN, MAX_SELECTORS, N_GROUPS, N_ITERS, NUM_OVERSHOOT_BYTES, rNums, RUNA, RUNB
Constructor and Description |
---|
CBZip2InputStream(InputStream in)
Constructs a new CBZip2InputStream which decompresses bytes read from
the specified stream.
|
CBZip2InputStream(InputStream in,
boolean decompressConcatenated)
Constructs a new CBZip2InputStream which decompresses bytes
read from the specified stream.
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes this input stream and releases any system resources associated with the stream.
|
int |
read()
Reads the next byte of data from the input stream.
|
int |
read(byte[] dest,
int offs,
int len)
Reads up to
len bytes of data from the input stream into an array of bytes. |
available, mark, markSupported, read, reset, skip
public CBZip2InputStream(InputStream in) throws IOException
Although BZip2 headers are marked with the magic "Bz" this constructor expects the next byte in the stream to be the first one after the magic. Thus callers have to skip the first two bytes. Otherwise this constructor will throw an exception.
IOException
- if the stream content is malformed or an I/O error occurs.NullPointerException
- if in == nullpublic CBZip2InputStream(InputStream in, boolean decompressConcatenated) throws IOException
Although BZip2 headers are marked with the magic "Bz" this constructor expects the next byte in the stream to be the first one after the magic. Thus callers have to skip the first two bytes. Otherwise this constructor will throw an exception.
in
- the InputStream from which this object should be createddecompressConcatenated
- if true, decompress until the end of the input;
if false, stop after the first .bz2 stream and
leave the input position to point to the next
byte after the .bz2 streamIOException
- if the stream content is malformed or an I/O error occurs.NullPointerException
- if in == nullpublic void close() throws IOException
InputStream
The close
method of InputStream
does nothing.
close
in interface Closeable
close
in interface AutoCloseable
close
in class InputStream
IOException
- if an I/O error occurs.public int read() throws IOException
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.
A subclass must provide an implementation of this method.
read
in class InputStream
-1
if the end of the stream is reached.IOException
- if an I/O error occurs.public int read(byte[] dest, int offs, int len) throws IOException
InputStream
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]
and elements
b[off+len]
through b[b.length-1]
are unaffected.
The read(b,
off,
len)
method for class
InputStream
simply calls the method read()
repeatedly. If the first
such call results in an IOException
, that exception is returned from the call to the
read(b,
off,
len)
method. If any subsequent call to
read()
results in a IOException
, the exception is caught and treated as
if it were end of file; the bytes read up to that point are stored into b
and the
number of bytes read before the exception occurred is returned. The default implementation of
this method blocks until the requested amount of input data len
has been read, end
of file is detected, or an exception is thrown. Subclasses are encouraged to provide a more
efficient implementation of this method.
read
in class InputStream
dest
- the buffer into which the data is read.offs
- the start offset in array b
at which the data is written.len
- the maximum number of bytes to read.-1
if there is no more
data because the end of the stream has been reached.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.InputStream.read()