org.gridfour.io

Class BitOutputStore

java.lang.Object

org.gridfour.io.BitOutputStore

public class BitOutputStore
extends Object

Writes a series of bits to an internal memory buffer (a "store").

Constructor Summary

Constructors

Constructor and Description
BitOutputStore() Construct bit-writer instance with empty content

Method Summary

Modifier and Type	Method and Description
void	appendBit(int value) Add a single bit to the bit-writer content.
void	appendBits(int nBitsInValue, int value) Adds the specified number of bits from the specified value to the content.
byte[]	getEncodedText() Gets an array of bytes populated with the content of the encoded text.
int	getEncodedTextLength() Gets the number of bits stored in the BitOutputStore's content.
int	getEncodedTextLengthInBytes()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BitOutputStore

public BitOutputStore()

Construct bit-writer instance with empty content

Method Detail

appendBit

public void appendBit(int value)

Add a single bit to the bit-writer content. If the input value is zero, a bit value of zero will be added to the content. If the input value is non-zero, a bit value of 1 will be added to the content.

Parameters:

value - an integer value.

appendBits

public void appendBits(int nBitsInValue,
                       int value)

Adds the specified number of bits from the specified value to the content. The input value may be a signed or unsigned quantity.

Parameters:

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

value - an integer containing the bits to be stored.

getEncodedText

public byte[] getEncodedText()

Gets an array of bytes populated with the content of the encoded text.

Returns:

a valid, potentially zero-length, array of bytes.

getEncodedTextLength

public int getEncodedTextLength()

Gets the number of bits stored in the BitOutputStore's content.

Returns:

a positive integer value.

getEncodedTextLengthInBytes

public int getEncodedTextLengthInBytes()

toString

public String toString()

Overrides:

toString in class Object