BitBuffer (bitbuffer 1.4.0 API)

java.lang.Object
- net.magik6k.bitbuffer.BitBuffer

```
public abstract class BitBuffer
extends java.lang.Object
```
The BitBuffer, useful to store data in bit-aligned format All multi-byte data structures are saved in Java byte order i.e. big endian

See Also:

allocate(long), allocateDirect(long)

Constructor Summary

Constructors
Constructor and Description

BitBuffer()

Constructors
Constructor and Description
`BitBuffer()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static BitBuffer`	`allocate(long bits)` Allocates new BitBuffer.
`static BitBuffer`	`allocateDirect(long bits)` Allocates new 'direct' BitBuffer.
`static BitBuffer`	`allocateDynamic()` Creates new auto-extending BitBuffer.
`static BitBuffer`	`allocateDynamic(int preallocateBits)` Creates new auto-extending BitBuffer with pre-allocated space.
`byte[]`	`asByteArray()` This method returns representation of this bufer as array of bytes.
`java.nio.ByteBuffer`	`asByteBuffer()` This method returns representation of this bufer as ByteBuffer.
`abstract boolean`	`canRead()`
`abstract boolean`	`canWrite()`
`abstract BitBuffer`	`flip()` Toggles the buffer betwen read/write modes.
`abstract boolean`	`getBoolean()`
`abstract byte`	`getByte()`
`abstract byte`	`getByte(int bits)`
`abstract byte`	`getByteUnsigned(int bits)`
`double`	`getDouble()`
`float`	`getFloat()`
`int`	`getInt()`
`int`	`getInt(int bits)`
`int`	`getIntUnsigned(int bits)`
`long`	`getLong()`
`long`	`getLong(int bits)`
`long`	`getLongUnsigned(int bits)`
`java.lang.String`	`getString(int length)`
`java.lang.String`	`getString(int length, java.nio.charset.Charset charset)`
`java.lang.String`	`getString(int length, java.nio.charset.Charset charset, int bitsPerChar)`
`java.lang.String`	`getString(int length, int bitsPerChar)`
`abstract long`	`limit()` This function returns Virtual 'end' of this buffer, in bits
`abstract long`	`position()` This function returns current position of cursor, in bits
`BitBuffer`	`put(BitBuffer buffer)` Reads entire given BitBuffer into this buffer
`BitBuffer`	`put(boolean bit)`
`BitBuffer`	`put(byte number)`
`BitBuffer`	`put(java.nio.ByteBuffer buffer)` Reads entire given `ByteBuffer` into this buffer
`BitBuffer`	`put(IBufferInsert data)` Insters given data into buffer
`BitBuffer`	`put(int number)`
`BitBuffer`	`put(long number)`
`BitBuffer`	`put(java.lang.String string)`
`BitBuffer`	`putBit(boolean bit)` Puts single bit(boolean value) to this buffer
`abstract BitBuffer`	`putBoolean(boolean b)` Puts boolean value(Single bit)
`abstract BitBuffer`	`putByte(byte b)` Puts signed byte value(8 bits)
`abstract BitBuffer`	`putByte(byte b, int bits)` Puts byte value with specified bit count.
`BitBuffer`	`putDouble(double d)` Puts double floating point value(64 bits)
`BitBuffer`	`putFloat(float f)` Puts floating point value(32 bits)
`BitBuffer`	`putInt(int i)` Puts signed integer value(32 bits)
`BitBuffer`	`putInt(int i, int bits)` Puts integer value with specified bit count.
`BitBuffer`	`putLong(long l)` Puts signed long value(64 bits)
`BitBuffer`	`putLong(long l, int bits)` Puts long value with specified bit count.
`BitBuffer`	`putString(java.lang.String s)` Puts `String` value(8 bits per char), using UTF-8 encoding
`BitBuffer`	`putString(java.lang.String s, java.nio.charset.Charset charset)` Puts `String` value
`BitBuffer`	`putString(java.lang.String s, java.nio.charset.Charset charset, int bitsPerChar)` Puts `String` value(specified amount of bits per byte), using specified encoding.
`BitBuffer`	`putString(java.lang.String s, int bitsPerChar)` Puts `String` value(specified amount bits per char), using ASCII encoding
`BitBuffer`	`putToByteBuffer(java.nio.ByteBuffer bb)` Puts this BitBuffer into ByteBuffer
`abstract BitBuffer`	`setPosition(long newPosition)` Sets cursor position for this buffer
`abstract long`	`size()` This function returns size of this buffer, in bits
`static BitBuffer`	`wrap(byte[] array)` Wraps bitbuffer around given array instance.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BitBuffer
```
public BitBuffer()
```
- Method Detail
  - putBoolean
```
public abstract BitBuffer putBoolean(boolean b)
```
    Puts boolean value(Single bit)
    
    Parameters:
    
    b - value to set
    
    Returns:
    
    This buffer
  - putBit
```
public BitBuffer putBit(boolean bit)
```
    Puts single bit(boolean value) to this buffer
    
    Parameters:
    
    bit - value to set
    
    Returns:
    
    This buffer
  - putByte
```
public abstract BitBuffer putByte(byte b)
```
    Puts signed byte value(8 bits)
    
    Parameters:
    
    b - value to set
    
    Returns:
    
    This buffer
  - putByte
```
public abstract BitBuffer putByte(byte b,
                                  int bits)
```
    Puts byte value with specified bit count. Note that this method can be used with both signed and unsigned data.
    
    Parameters:
    
    b - value to set
    
    bits - Number of bits to use
    
    Returns:
    
    This buffer
  - putInt
```
public BitBuffer putInt(int i)
```
    Puts signed integer value(32 bits)
    
    Parameters:
    
    i - value to set
    
    Returns:
    
    This buffer
  - putLong
```
public BitBuffer putLong(long l)
```
    Puts signed long value(64 bits)
    
    Parameters:
    
    l - value to set
    
    Returns:
    
    This buffer
  - putInt
```
public BitBuffer putInt(int i,
                        int bits)
```
    Puts integer value with specified bit count. Note that this method can be used with both signed and unsigned data.
    
    Parameters:
    
    i - value to set
    
    bits - Number of bits to use
    
    Returns:
    
    This buffer
  - putLong
```
public BitBuffer putLong(long l,
                         int bits)
```
    Puts long value with specified bit count. Note that this method can be used with both signed and unsigned data.
    
    Parameters:
    
    l - value to set
    
    bits - Number of bits to use
    
    Returns:
    
    This buffer
  - putFloat
```
public BitBuffer putFloat(float f)
```
    Puts floating point value(32 bits)
    
    Parameters:
    
    f - value to set
    
    Returns:
    
    This buffer
  - putDouble
```
public BitBuffer putDouble(double d)
```
    Puts double floating point value(64 bits)
    
    Parameters:
    
    d - value to set
    
    Returns:
    
    This buffer
  - putString
```
public BitBuffer putString(java.lang.String s)
```
    Puts String value(8 bits per char), using UTF-8 encoding
    
    Parameters:
    
    s - value to set
    
    Returns:
    
    This buffer
  - putString
```
public BitBuffer putString(java.lang.String s,
                           java.nio.charset.Charset charset)
```
    Puts String value
    
    Parameters:
    
    s - value to set
    
    charset - Charset to use
    
    Returns:
    
    This buffer
  - putString
```
public BitBuffer putString(java.lang.String s,
                           int bitsPerChar)
```
    Puts String value(specified amount bits per char), using ASCII encoding
    
    Parameters:
    
    s - value to set
    
    bitsPerChar - amount of bits to use per character
    
    Returns:
    
    This buffer
  - putString
```
public BitBuffer putString(java.lang.String s,
                           java.nio.charset.Charset charset,
                           int bitsPerChar)
```
    Puts String value(specified amount of bits per byte), using specified encoding. Use this method with care!
    
    Parameters:
    
    s - value to set
    
    charset - Charset to use
    
    bitsPerChar - amount of bits to use per character
    
    Returns:
    
    This buffer
  - put
```
public BitBuffer put(boolean bit)
```
    Parameters:
    
    bit - value to set
    
    Returns:
    
    This buffer
    
    See Also:
    
    putBoolean(boolean)
  - put
```
public BitBuffer put(byte number)
```
    Parameters:
    
    number - value to set
    
    Returns:
    
    This buffer
    
    See Also:
    
    putByte(byte)
  - put
```
public BitBuffer put(int number)
```
    Parameters:
    
    number - value to set
    
    Returns:
    
    This buffer
    
    See Also:
    
    putInt(int)
  - put
```
public BitBuffer put(long number)
```
    Parameters:
    
    number - value to set
    
    Returns:
    
    This buffer
    
    See Also:
    
    putLong(long)
  - put
```
public BitBuffer put(java.lang.String string)
```
    Parameters:
    
    string - value to set
    
    Returns:
    
    This buffer
    
    See Also:
    
    putLong(long)
  - put
```
public BitBuffer put(BitBuffer buffer)
```
    Reads entire given BitBuffer into this buffer
    
    Parameters:
    
    buffer - Readable buffer
    
    Returns:
    
    This buffer
  - put
```
public BitBuffer put(java.nio.ByteBuffer buffer)
```
    Reads entire given ByteBuffer into this buffer
    
    Parameters:
    
    buffer - Readable buffer
    
    Returns:
    
    This buffer
  - put
```
public BitBuffer put(IBufferInsert data)
```
    Insters given data into buffer
    
    Parameters:
    
    data - Instance of class implementing IBufferInsert
    
    Returns:
    
    This buffer
  - getBoolean
```
public abstract boolean getBoolean()
```
    Returns:
    
    Binary value of current bit
  - getByte
```
public abstract byte getByte()
```
    Returns:
    
    8 bit signed byte value
  - getByte
```
public abstract byte getByte(int bits)
```
    Parameters:
    
    bits - length of value in bits
    
    Returns:
    
    Signed Byte value of given bit width
  - getByteUnsigned
```
public abstract byte getByteUnsigned(int bits)
```
    Parameters:
    
    bits - length of value in bits
    
    Returns:
    
    Unsigned Byte value of given bit width
  - getInt
```
public int getInt()
```
    Returns:
    
    32 bit signed integer value
  - getInt
```
public int getInt(int bits)
```
    Parameters:
    
    bits - Length of integer
    
    Returns:
    
    Signed integer value of given bit width
  - getIntUnsigned
```
public int getIntUnsigned(int bits)
```
    Parameters:
    
    bits - Length of integer
    
    Returns:
    
    Unsigned Integer value of given bit width
  - getLong
```
public long getLong()
```
    Returns:
    
    64 bit signed long value
  - getLong
```
public long getLong(int bits)
```
    Parameters:
    
    bits - Length of long integer
    
    Returns:
    
    Signed long value of given bit width
  - getLongUnsigned
```
public long getLongUnsigned(int bits)
```
    Parameters:
    
    bits - Length of long integer
    
    Returns:
    
    Unsigned long value of given bit width
  - getFloat
```
public float getFloat()
```
    Returns:
    
    32 bit floating point value
  - getDouble
```
public double getDouble()
```
    Returns:
    
    64 bit floating point value
  - getString
```
public java.lang.String getString(int length)
```
    Parameters:
    
    length - Length of the string
    
    Returns:
    
    String of given length, with 8-bit wide characters, using UTF-8 encoding
  - getString
```
public java.lang.String getString(int length,
                                  java.nio.charset.Charset charset)
```
    Parameters:
    
    length - Length of the string
    
    charset - Charset to use for decoding
    
    Returns:
    
    String of given length, with 8-bit wide characters, using UTF-8 encoding
  - getString
```
public java.lang.String getString(int length,
                                  int bitsPerChar)
```
    Parameters:
    
    length - Length of the string
    
    bitsPerChar - amount of bits used per char
    
    Returns:
    
    String of given length, using ASCII encoding
  - getString
```
public java.lang.String getString(int length,
                                  java.nio.charset.Charset charset,
                                  int bitsPerChar)
```
    Parameters:
    
    length - Length of the string
    
    charset - Charset to use for decoding
    
    bitsPerChar - amount of bits used per char
    
    Returns:
    
    String of given length, using ASCII encoding
  - flip
```
public abstract BitBuffer flip()
```
    Toggles the buffer betwen read/write modes. Limit is set at current position, and cursor is set at position 0
    
    Returns:
    
    This BitBuffer
  - canRead
```
public abstract boolean canRead()
```
    Returns:
    
    Boolean value telling if the buffer can output data
  - canWrite
```
public abstract boolean canWrite()
```
    Returns:
    
    Boolean value telling if the buffer can accept data
  - asByteArray
```
public byte[] asByteArray()
```
    This method returns representation of this bufer as array of bytes. nota that not-full bits will be set to 0. This method shouldn't affect the position.
    
    Returns:
    
    This BitBuffer represented as byte array
  - asByteBuffer
```
public java.nio.ByteBuffer asByteBuffer()
```
    This method returns representation of this bufer as ByteBuffer. nota that not-full bits will be set to 0. This method shouldn't affect the position.
    
    Returns:
    
    ByteBuffer version of this class
  - putToByteBuffer
```
public BitBuffer putToByteBuffer(java.nio.ByteBuffer bb)
```
    Puts this BitBuffer into ByteBuffer
    
    Parameters:
    
    bb - ByteBuffer to put data to
    
    Returns:
    
    This buffer
  - size
```
public abstract long size()
```
    This function returns size of this buffer, in bits
    
    Returns:
    
    Size of this buffer, in bits
  - limit
```
public abstract long limit()
```
    This function returns Virtual 'end' of this buffer, in bits
    
    Returns:
    
    Virtual 'end' of this buffer, in bits
  - position
```
public abstract long position()
```
    This function returns current position of cursor, in bits
    
    Returns:
    
    Current position of cursor, in bits
  - setPosition
```
public abstract BitBuffer setPosition(long newPosition)
```
    Sets cursor position for this buffer
    
    Parameters:
    
    newPosition - position to set
    
    Returns:
    
    This buffer
  - allocate
```
public static BitBuffer allocate(long bits)
```
    Allocates new BitBuffer. First bit is MSB of byte 0.
    
    Parameters:
    
    bits - Amount of bits to allocate
    
    Returns:
    
    Newly created instance of BitBuffer
  - allocateDirect
```
public static BitBuffer allocateDirect(long bits)
```
    Allocates new 'direct' BitBuffer. This buffer is allocated using off-heap, native memory. This solution MAY be faster, however you may notice way slower allocation.
    
    Parameters:
    
    bits - Amount of bits to allocate
    
    Returns:
    
    Newly created instance of BitBuffer
  - allocateDynamic
```
public static BitBuffer allocateDynamic()
```
    Creates new auto-extending BitBuffer. Limit of this buffer in write mode has no real meaning.
    
    Returns:
    
    Newly created instance of BitBuffer
  - allocateDynamic
```
public static BitBuffer allocateDynamic(int preallocateBits)
```
    Creates new auto-extending BitBuffer with pre-allocated space. Limit of this buffer in write mode has no real meaning.
    
    Parameters:
    
    preallocateBits - Amount of space to pre-allocate, in bits
    
    Returns:
    
    Newly created instance of BitBuffer
  - wrap
```
public static BitBuffer wrap(byte[] array)
```
    Wraps bitbuffer around given array instance. Any operation on this bitBuffer will modify the array
    
    Parameters:
    
    array - A byte array to wrap this buffer around
    
    Returns:
    
    Newly created instance of BitBuffer wrapped around array

Class BitBuffer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BitBuffer

Method Detail

putBoolean

putBit

putByte

putByte

putInt

putLong

putInt

putLong

putFloat

putDouble

putString

putString

putString

putString

put

put

put

put

put

put

put

put

getBoolean

getByte

getByte

getByteUnsigned

getInt

getInt

getIntUnsigned

getLong

getLong

getLongUnsigned

getFloat

getDouble

getString

getString

getString

getString

flip

canRead

canWrite

asByteArray

asByteBuffer

putToByteBuffer

size

limit

position

setPosition

allocate

allocateDirect

allocateDynamic

allocateDynamic

wrap