BitStreamWriter

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

ByteArrayBitStreamWriter
```
public interface BitStreamWriter
extends java.io.Closeable
```
An interface for a bit stream writer implementation.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`alignTo(int alignVal)` Aligns the bit position according to the aligning value.
`long`	`getBitPosition()` Gets the current bit position.
`int`	`getBytePosition()` Gets the current byte position.
`void`	`setBitPosition(long position)` Sets the bit position to the given value.
`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 value)` 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 value)` Writes a signed integer to the underlying storage.
`void`	`writeLong(long value)` Writes a signed long to the underlying storage.
`void`	`writeShort(short value)` 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 interface java.io.Closeable
close

- Method Detail
  - writeSignedBits
```
void writeSignedBits(long value,
                     int numBits)
              throws java.io.IOException
```
    Writes the given value with the given number of signed bits to the underlying storage.
    
    Parameters:
    
    value - Value to write.
    
    numBits - Number of bits for the value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeBits
```
void writeBits(long value,
               int numBits)
        throws java.io.IOException
```
    Writes the given value with the given number of unsigned bits to the underlying storage.
    
    Parameters:
    
    value - Value to write.
    
    numBits - Number of bits for the value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeByte
```
void writeByte(byte value)
        throws java.io.IOException
```
    Writes a signed byte to the underlying storage.
    
    Parameters:
    
    value - Signed byte value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeUnsignedByte
```
void writeUnsignedByte(short value)
                throws java.io.IOException
```
    Writes an unsigned byte to the underlying storage.
    
    Parameters:
    
    value - Unsigned byte value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeShort
```
void writeShort(short value)
         throws java.io.IOException
```
    Writes a signed short to the underlying storage.
    
    Parameters:
    
    value - Signed short value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeUnsignedShort
```
void writeUnsignedShort(int value)
                 throws java.io.IOException
```
    Writes an unsigned short to the underlying storage.
    
    Parameters:
    
    value - Unsigned short value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeInt
```
void writeInt(int value)
       throws java.io.IOException
```
    Writes a signed integer to the underlying storage.
    
    Parameters:
    
    value - Signed integer value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeUnsignedInt
```
void writeUnsignedInt(long value)
               throws java.io.IOException
```
    Writes an unsigned integer to the underlying storage.
    
    Parameters:
    
    value - Unsigned integer value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeLong
```
void writeLong(long value)
        throws java.io.IOException
```
    Writes a signed long to the underlying storage.
    
    Parameters:
    
    value - Signed integer value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeBigInteger
```
void writeBigInteger(java.math.BigInteger value,
                     int numBits)
              throws java.io.IOException
```
    Writes a given big integer value with the given number of bits to the underlying storage.
    
    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
```
void writeFloat16(float value)
           throws java.io.IOException
```
    Writes a 16-bit float value to the underlying storage.
    
    Parameters:
    
    value - Half precision float value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeFloat32
```
void writeFloat32(float value)
           throws java.io.IOException
```
    Writes a 32-bit float value to the underlying storage.
    
    Parameters:
    
    value - Single precision float value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeFloat64
```
void writeFloat64(double value)
           throws java.io.IOException
```
    Writes a 64-bit float value to the underlying storage.
    
    Parameters:
    
    value - Double precision float value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeBytes
```
void writeBytes(byte[] value)
         throws java.io.IOException
```
    Writes a Zserio bytes to the underlying storage.
    
    Parameters:
    
    value - Zserio bytes to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeString
```
void writeString(java.lang.String value)
          throws java.io.IOException
```
    Writes a Zserio string to the underlying storage in UTF-8 encoding.
    
    Parameters:
    
    value - Zserio string to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeBool
```
void writeBool(boolean value)
        throws java.io.IOException
```
    Writes a boolean value to the underlying storage.
    
    Parameters:
    
    value - Boolean value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeVarInt16
```
void writeVarInt16(short value)
            throws java.io.IOException
```
    Writes a variable 16 bit integer value to the underlying storage.
    
    Parameters:
    
    value - Variable 17 bit integer value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeVarUInt16
```
void writeVarUInt16(short value)
             throws java.io.IOException
```
    Writes a variable 16 bit unsigned integer value to the underlying storage.
    
    Parameters:
    
    value - Variable 16 bit unsigned integer value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeVarInt32
```
void writeVarInt32(int value)
            throws java.io.IOException
```
    Writes a variable 32 bit integer value to the underlying storage.
    
    Parameters:
    
    value - Variable 32 bit integer value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeVarUInt32
```
void writeVarUInt32(int value)
             throws java.io.IOException
```
    Writes a variable 32 bit unsigned integer value to the underlying storage.
    
    Parameters:
    
    value - Variable 32 bit unsigned integer value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeVarInt64
```
void writeVarInt64(long value)
            throws java.io.IOException
```
    Writes a variable 64 bit integer value to the underlying storage.
    
    Parameters:
    
    value - Variable 64 bit integer value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeVarUInt64
```
void writeVarUInt64(long value)
             throws java.io.IOException
```
    Writes a variable 64 bit unsigned integer value to the underlying storage.
    
    Parameters:
    
    value - Variable 64 bit unsigned integer value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeVarInt
```
void writeVarInt(long value)
          throws java.io.IOException
```
    Writes a variable signed integer value to the underlying storage.
    
    Parameters:
    
    value - Variable signed integer value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeVarUInt
```
void writeVarUInt(java.math.BigInteger value)
           throws java.io.IOException
```
    Writes a variable unsigned integer value to the underlying storage.
    
    Parameters:
    
    value - Variable unsigned integer value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeVarSize
```
void writeVarSize(int value)
           throws java.io.IOException
```
    Writes a variable size integer value to the underlying storage.
    
    Parameters:
    
    value - Variable size integer value to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - writeBitBuffer
```
void writeBitBuffer(BitBuffer bitBuffer)
             throws java.io.IOException
```
    Writes a bit buffer to the underlying storage.
    
    Parameters:
    
    bitBuffer - Bit buffer to write.
    
    Throws:
    
    java.io.IOException - If the writing failed.
  - getBitPosition
```
long getBitPosition()
```
    Gets the current bit position.
    
    Returns:
    
    Current bit position counted from zero.
  - getBytePosition
```
int getBytePosition()
```
    Gets the current byte position.
    
    Returns:
    
    Current byte position counted from zero.
  - setBitPosition
```
void setBitPosition(long position)
             throws java.io.IOException
```
    Sets the bit position to the given value.
    
    Parameters:
    
    position - Bit position counted from zero to set.
    
    Throws:
    
    java.io.IOException - If the position cannot be set.
  - alignTo
```
void alignTo(int alignVal)
      throws java.io.IOException
```
    Aligns the bit position according to the aligning value.
    
    Parameters:
    
    alignVal - An aligning value to use.
    
    Throws:
    
    java.io.IOException - If the alignment failed.

Interface BitStreamWriter

Method Summary

Methods inherited from interface java.io.Closeable

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

getBitPosition

getBytePosition

setBitPosition

alignTo