org.apache.tools.bzip2

Class CBZip2InputStream

Implemented Interfaces:
BZip2Constants

public class CBZip2InputStream
extends InputStream
implements BZip2Constants

An input stream that decompresses from the BZip2 format (without the file header chars) to be read as any other stream.

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.

Fields inherited from interface org.apache.tools.bzip2.BZip2Constants

G_SIZE, MAX_ALPHA_SIZE, MAX_CODE_LEN, MAX_SELECTORS, NUM_OVERSHOOT_BYTES, N_GROUPS, N_ITERS, RUNA, RUNB, baseBlockSize, rNums

Constructor Summary

CBZip2InputStream(InputStream in)
Constructs a new CBZip2InputStream which decompresses bytes read from the specified stream.

Method Summary

void
close()
int
read()
int
read(byte[] dest, int offs, int len)

Constructor Details

CBZip2InputStream

public CBZip2InputStream(InputStream in)
            throws IOException
Constructs a new CBZip2InputStream which decompresses bytes read from the specified stream.

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.

Method Details

close

public void close()
            throws IOException

read

public int read()
            throws IOException

read

public int read(byte[] dest,
                int offs,
                int len)
            throws IOException