de.carne.nio.compression.common

Class BitRegister

java.lang.Object

de.carne.nio.compression.common.BitRegister

Direct Known Subclasses:

LSBBitstreamBitRegister, LSBBytesBitRegister

public abstract class BitRegister
extends java.lang.Object

Package private base class for the various bit register types.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	bitCount Number of bits currently stored in the register.
static int	MAX_BIT_COUNT The maximum number of bits to access.
protected long	register Bit store.

Method Summary

Modifier and Type	Method and Description
int	bitCount() Get the number of bits currently stored in the register.
void	clear() Clear all bits.
abstract int	discardBits(int count) Discard bits from the register.
abstract int	feedBits(byte b) Feed additional bits to the register.
abstract int	peekBits(int count) Take a peek at the register's bits.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_BIT_COUNT

public static final int MAX_BIT_COUNT

The maximum number of bits to access.

See Also:

Constant Field Values

register

protected long register

Bit store.

bitCount

protected int bitCount

Number of bits currently stored in the register.

Method Detail

clear

public final void clear()

Clear all bits.

bitCount

public final int bitCount()

Get the number of bits currently stored in the register.

Returns:

The number of bits currently stored in the register.

feedBits

public abstract int feedBits(byte b)

Feed additional bits to the register.

Parameters:

b - The byte bits to feed.

Returns:

The updated number of bits stored in the register.

peekBits

public abstract int peekBits(int count)

Take a peek at the register's bits.

Parameters:

count - The number of bits to return.

Returns:

The register bits.

discardBits

public abstract int discardBits(int count)

Discard bits from the register.

Parameters:

count - The number of bits to discard.

Returns:

The updated number of bits stored in the register.