zserio.runtime.io

Class BitBuffer

java.lang.Object

zserio.runtime.io.BitBuffer

public final class BitBuffer
extends java.lang.Object

Class which holds any bit sequence. Because bit buffer size does not have to be byte aligned (divisible by 8), it's possible that not all bits of the last byte are used. In this case, only most significant bits of the corresponded size are used.

Constructor Summary

Constructors

Constructor and Description
BitBuffer(byte[] buffer) Constructor from byte buffer.
BitBuffer(byte[] buffer, long bitSize) Constructor from byte buffer and bit size.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
long	getBitSize() Gets the number of bits stored in the bit buffer.
byte[]	getBuffer() Gets the underlying byte buffer.
int	getByteSize() Gets the number of bytes stored in the bit buffer.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

BitBuffer

public BitBuffer(byte[] buffer)

Constructor from byte buffer. All bits of the last buffer byte will be used.

Parameters:

buffer - Byte buffer to construct from.

BitBuffer

public BitBuffer(byte[] buffer,
                 long bitSize)
          throws java.lang.IllegalArgumentException

Constructor from byte buffer and bit size.

Parameters:

buffer - Byte buffer to construct from.

bitSize - Number of bits stored in buffer to use.

Throws:

java.lang.IllegalArgumentException - If the number of bits is bigger than buffer size.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getBuffer

public byte[] getBuffer()

Gets the underlying byte buffer. Not all bits of the last byte must be used.

Returns:

The underlying byte buffer.

getBitSize

public long getBitSize()

Gets the number of bits stored in the bit buffer.

Returns:

Size of the bit buffer in bits.

getByteSize

public int getByteSize()

Gets the number of bytes stored in the bit buffer.

Returns:

Size of the bit buffer in bytes.