org.itadaki.bzip2

Class BZip2BitInputStream

java.lang.Object

org.itadaki.bzip2.BZip2BitInputStream

public class BZip2BitInputStream
extends Object

An InputStream wrapper that allows the reading of single bit booleans, unary numbers, bit strings of arbitrary length (up to 24 bits), and bit aligned 32-bit integers. A single byte at a time is read from the wrapped stream when more bits are required

Constructor Summary

Constructors

Constructor and Description
BZip2BitInputStream(InputStream inputStream)

Method Summary

Methods

Modifier and Type	Method and Description
int	readBits(int count) Reads up to 24 bits from the wrapped input stream
boolean	readBoolean() Reads a single bit from the wrapped input stream
int	readInteger() Reads 32 bits of input as an integer
int	readUnary() Reads a zero-terminated unary number from the wrapped input stream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BZip2BitInputStream

public BZip2BitInputStream(InputStream inputStream)

Parameters:

inputStream - The InputStream to wrap

Method Detail

readBoolean

public boolean readBoolean()
                    throws IOException

Reads a single bit from the wrapped input stream

Returns:

true if the bit read was 1, otherwise false

Throws:

IOException - if no more bits are available in the input stream

readUnary

public int readUnary()
              throws IOException

Reads a zero-terminated unary number from the wrapped input stream

Returns:

The unary number

Throws:

IOException - if no more bits are available in the input stream

readBits

public int readBits(int count)
             throws IOException

Reads up to 24 bits from the wrapped input stream

Parameters:

count - The number of bits to read (maximum 24)

Returns:

The bits requested, right-aligned within the integer

Throws:

IOException - if more bits are requested than are available in the input stream

readInteger

public int readInteger()
                throws IOException

Reads 32 bits of input as an integer

Returns:

The integer read

Throws:

IOException - if 32 bits are not available in the input stream