ByteArrayBitStreamWriter

java.lang.Object
- zserio.runtime.io.ByteArrayBitStreamWriter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, BitStreamWriter
```
public final class ByteArrayBitStreamWriter
extends java.lang.Object
implements BitStreamWriter
```
A bit stream writer using byte array.

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`bitOffset` The current bit offset.
`protected static byte`	`BYTE_MOD_MASK` Byte value used for modulus calculations.
`protected int`	`bytePosition` The current byte position.
`protected static java.lang.String`	`DEFAULT_CHARSET_NAME` The default character set.

Constructor Summary

Constructors
Constructor and Description
`ByteArrayBitStreamWriter()` Constructs a new byte array bit stream writer with default capacity and the default endian byte order.
`ByteArrayBitStreamWriter(int initialCapacity)` Constructs a new byte array bit stream writer with the given buffer capacity.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`alignTo(int alignVal)` Aligns the bit position according to the aligning value.
`protected static void`	`checkRange(int numBits)` Checks if the given numBits value is situated in the range 0 to 64.
`protected static void`	`checkUnsignedRange(int numBits)` Checks if the given numBits value is situated in the range 0 to 63.
`void`	`close()`
`int`	`getBitOffset()` Gets the current bit offset.
`long`	`getBitPosition()` Gets the current bit position.
`int`	`getBytePosition()` Gets the current byte position.
`void`	`setBitPosition(long bitPosition)` Sets the bit position to the given value.
`byte[]`	`toByteArray()` Returns the underlying buffer content as byte array.
`void`	`writeBigInteger(java.math.BigInteger value, int numBits)` Writes a given big integer value with the given number of bits to the underlying storage.
`void`	`writeBitBuffer(BitBuffer bitBuffer)` Writes a bit buffer to the underlying storage.
`void`	`writeBits(long value, int numBits)` Writes the given value with the given number of unsigned bits to the underlying storage.
`void`	`writeBool(boolean value)` Writes a boolean value to the underlying storage.
`void`	`writeByte(byte v)` Writes a signed byte to the underlying storage.
`void`	`writeBytes(byte[] value)` Writes a Zserio bytes to the underlying storage.
`void`	`writeFloat16(float value)` Writes a 16-bit float value to the underlying storage.
`void`	`writeFloat32(float value)` Writes a 32-bit float value to the underlying storage.
`void`	`writeFloat64(double value)` Writes a 64-bit float value to the underlying storage.
`void`	`writeInt(int v)` Writes a signed integer to the underlying storage.
`void`	`writeLong(long v)` Writes a signed long to the underlying storage.
`void`	`writeShort(short v)` Writes a signed short to the underlying storage.
`void`	`writeSignedBits(long value, int numBits)` Writes the given value with the given number of signed bits to the underlying storage.
`void`	`writeString(java.lang.String value)` Writes a Zserio string to the underlying storage in UTF-8 encoding.
`void`	`writeUnsignedByte(short value)` Writes an unsigned byte to the underlying storage.
`void`	`writeUnsignedInt(long value)` Writes an unsigned integer to the underlying storage.
`void`	`writeUnsignedShort(int value)` Writes an unsigned short to the underlying storage.
`void`	`writeVarInt(long value)` Writes a variable signed integer value to the underlying storage.
`void`	`writeVarInt16(short value)` Writes a variable 16 bit integer value to the underlying storage.
`void`	`writeVarInt32(int value)` Writes a variable 32 bit integer value to the underlying storage.
`void`	`writeVarInt64(long value)` Writes a variable 64 bit integer value to the underlying storage.
`void`	`writeVarSize(int value)` Writes a variable size integer value to the underlying storage.
`void`	`writeVarUInt(java.math.BigInteger value)` Writes a variable unsigned integer value to the underlying storage.
`void`	`writeVarUInt16(short value)` Writes a variable 16 bit unsigned integer value to the underlying storage.
`void`	`writeVarUInt32(int value)` Writes a variable 32 bit unsigned integer value to the underlying storage.
`void`	`writeVarUInt64(long value)` Writes a variable 64 bit unsigned integer value to the underlying storage.

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

Methods inherited from interface zserio.runtime.io.BitStreamWriter
getBitPosition, getBytePosition, setBitPosition

- Field Detail
  - bytePosition
```
protected int bytePosition
```
    The current byte position.
  - bitOffset
```
protected int bitOffset
```
    The current bit offset.
  - DEFAULT_CHARSET_NAME
```
protected static final java.lang.String DEFAULT_CHARSET_NAME
```
    The default character set.
    
    See Also:
    
    Constant Field Values
  - BYTE_MOD_MASK
```
protected static final byte BYTE_MOD_MASK
```
    Byte value used for modulus calculations.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ByteArrayBitStreamWriter
```
public ByteArrayBitStreamWriter()
```
    Constructs a new byte array bit stream writer with default capacity and the default endian byte order.
  - ByteArrayBitStreamWriter
```
public ByteArrayBitStreamWriter(int initialCapacity)
```
    Constructs a new byte array bit stream writer with the given buffer capacity.
    
    Parameters:
    
    initialCapacity - Underlying byte array capacity in bytes.
- Method Detail
  - writeSignedBits
```
public void writeSignedBits(long value,
                            int numBits)
                     throws java.io.IOException
```
    Description copied from interface: BitStreamWriter
    
    Writes the given value with the given number of signed bits to the underlying storage.
    
    Specified by:
    
    writeSignedBits in interface BitStreamWriter
    
    Parameters:
    
    value - Value to write.
    
    numBits - Number of bits for the value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeBits
```
public void writeBits(long value,
                      int numBits)
               throws java.io.IOException
```
    Description copied from interface: BitStreamWriter
    
    Writes the given value with the given number of unsigned bits to the underlying storage.
    
    Specified by:
    
    writeBits in interface BitStreamWriter
    
    Parameters:
    
    value - Value to write.
    
    numBits - Number of bits for the value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeByte
```
public void writeByte(byte v)
               throws java.io.IOException
```
    Description copied from interface: BitStreamWriter
    
    Writes a signed byte to the underlying storage.
    
    Specified by:
    
    writeByte in interface BitStreamWriter
    
    Parameters:
    
    v - Signed byte value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeUnsignedByte
```
public void writeUnsignedByte(short value)
                       throws java.io.IOException
```
    Description copied from interface: BitStreamWriter
    
    Writes an unsigned byte to the underlying storage.
    
    Specified by:
    
    writeUnsignedByte in interface BitStreamWriter
    
    Parameters:
    
    value - Unsigned byte value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeShort
```
public void writeShort(short v)
                throws java.io.IOException
```
    Description copied from interface: BitStreamWriter
    
    Writes a signed short to the underlying storage.
    
    Specified by:
    
    writeShort in interface BitStreamWriter
    
    Parameters:
    
    v - Signed short value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeUnsignedShort
```
public void writeUnsignedShort(int value)
                        throws java.io.IOException
```
    Description copied from interface: BitStreamWriter
    
    Writes an unsigned short to the underlying storage.
    
    Specified by:
    
    writeUnsignedShort in interface BitStreamWriter
    
    Parameters:
    
    value - Unsigned short value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeInt
```
public void writeInt(int v)
              throws java.io.IOException
```
    Description copied from interface: BitStreamWriter
    
    Writes a signed integer to the underlying storage.
    
    Specified by:
    
    writeInt in interface BitStreamWriter
    
    Parameters:
    
    v - Signed integer value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeUnsignedInt
```
public void writeUnsignedInt(long value)
                      throws java.io.IOException
```
    Description copied from interface: BitStreamWriter
    
    Writes an unsigned integer to the underlying storage.
    
    Specified by:
    
    writeUnsignedInt in interface BitStreamWriter
    
    Parameters:
    
    value - Unsigned integer value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeLong
```
public void writeLong(long v)
               throws java.io.IOException
```
    Description copied from interface: BitStreamWriter
    
    Writes a signed long to the underlying storage.
    
    Specified by:
    
    writeLong in interface BitStreamWriter
    
    Parameters:
    
    v - Signed integer value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeBigInteger
```
public void writeBigInteger(java.math.BigInteger value,
                            int numBits)
                     throws java.io.IOException
```
    Description copied from interface: BitStreamWriter
    
    Writes a given big integer value with the given number of bits to the underlying storage.
    
    Specified by:
    
    writeBigInteger in interface BitStreamWriter
    
    Parameters:
    
    value - Big integer value to write.
    
    numBits - Number of bits for the value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeFloat16
```
public void writeFloat16(float value)
                  throws java.io.IOException
```
    Description copied from interface: BitStreamWriter
    
    Writes a 16-bit float value to the underlying storage.
    
    Specified by:
    
    writeFloat16 in interface BitStreamWriter
    
    Parameters:
    
    value - Half precision float value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeFloat32
```
public void writeFloat32(float value)
                  throws java.io.IOException
```
    Description copied from interface: BitStreamWriter
    
    Writes a 32-bit float value to the underlying storage.
    
    Specified by:
    
    writeFloat32 in interface BitStreamWriter
    
    Parameters:
    
    value - Single precision float value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeFloat64
```
public void writeFloat64(double value)
                  throws java.io.IOException
```
    Description copied from interface: BitStreamWriter
    
    Writes a 64-bit float value to the underlying storage.
    
    Specified by:
    
    writeFloat64 in interface BitStreamWriter
    
    Parameters:
    
    value - Double precision float value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeBytes
```
public void writeBytes(byte[] value)
                throws java.io.IOException
```
    Description copied from interface: BitStreamWriter
    
    Writes a Zserio bytes to the underlying storage.
    
    Specified by:
    
    writeBytes in interface BitStreamWriter
    
    Parameters:
    
    value - Zserio bytes to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeString
```
public void writeString(java.lang.String value)
                 throws java.io.IOException
```
    Description copied from interface: BitStreamWriter
    
    Writes a Zserio string to the underlying storage in UTF-8 encoding.
    
    Specified by:
    
    writeString in interface BitStreamWriter
    
    Parameters:
    
    value - Zserio string to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeBool
```
public void writeBool(boolean value)
               throws java.io.IOException
```
    Description copied from interface: BitStreamWriter
    
    Writes a boolean value to the underlying storage.
    
    Specified by:
    
    writeBool in interface BitStreamWriter
    
    Parameters:
    
    value - Boolean value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeVarInt16
```
public void writeVarInt16(short value)
                   throws java.io.IOException
```
    Description copied from interface: BitStreamWriter
    
    Writes a variable 16 bit integer value to the underlying storage.
    
    Specified by:
    
    writeVarInt16 in interface BitStreamWriter
    
    Parameters:
    
    value - Variable 17 bit integer value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeVarUInt16
```
public void writeVarUInt16(short value)
                    throws java.io.IOException
```
    Description copied from interface: BitStreamWriter
    
    Writes a variable 16 bit unsigned integer value to the underlying storage.
    
    Specified by:
    
    writeVarUInt16 in interface BitStreamWriter
    
    Parameters:
    
    value - Variable 16 bit unsigned integer value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeVarInt32
```
public void writeVarInt32(int value)
                   throws java.io.IOException
```
    Description copied from interface: BitStreamWriter
    
    Writes a variable 32 bit integer value to the underlying storage.
    
    Specified by:
    
    writeVarInt32 in interface BitStreamWriter
    
    Parameters:
    
    value - Variable 32 bit integer value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeVarUInt32
```
public void writeVarUInt32(int value)
                    throws java.io.IOException
```
    Description copied from interface: BitStreamWriter
    
    Writes a variable 32 bit unsigned integer value to the underlying storage.
    
    Specified by:
    
    writeVarUInt32 in interface BitStreamWriter
    
    Parameters:
    
    value - Variable 32 bit unsigned integer value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeVarInt64
```
public void writeVarInt64(long value)
                   throws java.io.IOException
```
    Description copied from interface: BitStreamWriter
    
    Writes a variable 64 bit integer value to the underlying storage.
    
    Specified by:
    
    writeVarInt64 in interface BitStreamWriter
    
    Parameters:
    
    value - Variable 64 bit integer value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeVarUInt64
```
public void writeVarUInt64(long value)
                    throws java.io.IOException
```
    Description copied from interface: BitStreamWriter
    
    Writes a variable 64 bit unsigned integer value to the underlying storage.
    
    Specified by:
    
    writeVarUInt64 in interface BitStreamWriter
    
    Parameters:
    
    value - Variable 64 bit unsigned integer value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeVarInt
```
public void writeVarInt(long value)
                 throws java.io.IOException
```
    Description copied from interface: BitStreamWriter
    
    Writes a variable signed integer value to the underlying storage.
    
    Specified by:
    
    writeVarInt in interface BitStreamWriter
    
    Parameters:
    
    value - Variable signed integer value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeVarUInt
```
public void writeVarUInt(java.math.BigInteger value)
                  throws java.io.IOException
```
    Description copied from interface: BitStreamWriter
    
    Writes a variable unsigned integer value to the underlying storage.
    
    Specified by:
    
    writeVarUInt in interface BitStreamWriter
    
    Parameters:
    
    value - Variable unsigned integer value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeVarSize
```
public void writeVarSize(int value)
                  throws java.io.IOException
```
    Description copied from interface: BitStreamWriter
    
    Writes a variable size integer value to the underlying storage.
    
    Specified by:
    
    writeVarSize in interface BitStreamWriter
    
    Parameters:
    
    value - Variable size integer value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeBitBuffer
```
public void writeBitBuffer(BitBuffer bitBuffer)
                    throws java.io.IOException
```
    Description copied from interface: BitStreamWriter
    
    Writes a bit buffer to the underlying storage.
    
    Specified by:
    
    writeBitBuffer in interface BitStreamWriter
    
    Parameters:
    
    bitBuffer - Bit buffer to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - alignTo
```
public void alignTo(int alignVal)
             throws java.io.IOException
```
    Description copied from interface: BitStreamWriter
    
    Aligns the bit position according to the aligning value.
    
    Specified by:
    
    alignTo in interface BitStreamWriter
    
    Parameters:
    
    alignVal - An aligning value to use.
    
    Throws:
    
    java.io.IOException - If the alignment failed.
  - close
```
public void close()
           throws java.io.IOException
```
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    java.io.IOException
  - toByteArray
```
public byte[] toByteArray()
                   throws java.io.IOException
```
    Returns the underlying buffer content as byte array.
    
    Returns:
    
    A byte array containing the buffer values.
    
    Throws:
    
    java.io.IOException - If stream manipulation failed.
  - getBitPosition
```
public long getBitPosition()
```
    Gets the current bit position.
    
    Returns:
    
    Bit position counted from zero.
  - getBytePosition
```
public int getBytePosition()
```
    Gets the current byte position.
    
    Returns:
    
    Byte position counted from zero.
  - setBitPosition
```
public void setBitPosition(long bitPosition)
                    throws java.io.IOException
```
    Sets the bit position to the given value.
    
    Parameters:
    
    bitPosition - Bit position to set.
    
    Throws:
    
    java.io.IOException - Throws in case of any error.
  - getBitOffset
```
public int getBitOffset()
```
    Gets the current bit offset.
    
    Returns:
    
    Bit offset counted from zero.
  - checkRange
```
protected static void checkRange(int numBits)
                          throws java.lang.IllegalArgumentException
```
    Checks if the given numBits value is situated in the range 0 to 64.
    
    Parameters:
    
    numBits - Number of bits to check.
    
    Throws:
    
    java.lang.IllegalArgumentException - If the numBits value is smaller than zero or greater than 64.
  - checkUnsignedRange
```
protected static void checkUnsignedRange(int numBits)
                                  throws java.lang.IllegalArgumentException
```
    Checks if the given numBits value is situated in the range 0 to 63.
    
    Parameters:
    
    numBits - Number of bits to check.
    
    Throws:
    
    java.lang.IllegalArgumentException - If the numBits value is smaller than zero or greater than 63.

Class ByteArrayBitStreamWriter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface zserio.runtime.io.BitStreamWriter

Field Detail

bytePosition

bitOffset

DEFAULT_CHARSET_NAME

BYTE_MOD_MASK

Constructor Detail

ByteArrayBitStreamWriter

ByteArrayBitStreamWriter

Method Detail

writeSignedBits

writeBits

writeByte

writeUnsignedByte

writeShort

writeUnsignedShort

writeInt

writeUnsignedInt

writeLong

writeBigInteger

writeFloat16

writeFloat32

writeFloat64

writeBytes

writeString

writeBool

writeVarInt16

writeVarUInt16

writeVarInt32

writeVarUInt32

writeVarInt64

writeVarUInt64

writeVarInt

writeVarUInt

writeVarSize

writeBitBuffer

alignTo

close

toByteArray

getBitPosition

getBytePosition

setBitPosition

getBitOffset

checkRange

checkUnsignedRange