org.gridfour.io

Class BitInputStore

java.lang.Object

org.gridfour.io.BitInputStore

public class BitInputStore
extends Object

Writes a series of bits to an internal memory buffer.

Constructor Summary

Constructors

Constructor and Description
BitInputStore(byte[] input) Construct a reader that will extract bits from the specified input.
BitInputStore(byte[] input, int offset, int length) Construct a reader that will extract bits from the specified input.

Method Summary

Modifier and Type	Method and Description
int	getBit() Gets a single bit to the bit-writer content.
int	getBits(int nBitsInValue) Gets the specified number of bits from the context
int	getPosition() Gets the current bit position within the input store.

Methods inherited from class java.lang.Object

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

Constructor Detail

BitInputStore

public BitInputStore(byte[] input)

Construct a reader that will extract bits from the specified input.

Parameters:

input - a valid array of bytes storing the content.

BitInputStore

public BitInputStore(byte[] input,
                     int offset,
                     int length)

Construct a reader that will extract bits from the specified input.

Parameters:

input - a valid array of bytes storing the content.

offset - the starting offset within the input

length - the number of bytes from the input that are valid; it is assumed that input is at least length+offset bytes long.

Method Detail

getBit

public int getBit()

Gets a single bit to the bit-writer content.

Returns:

a value of 1 or 0

getBits

public int getBits(int nBitsInValue)

Gets the specified number of bits from the context

Parameters:

nBitsInValue - number of bits in the range 1 to 32.

Returns:

a valid integer value composed using the specified number of bits from the content.

getPosition

public int getPosition()

Gets the current bit position within the input store. This is the position from which the next bit will be read.

Returns:

a value of zero or greater.