BitStreamReader

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

ByteArrayBitStreamReader, ValidationBitStreamReader
```
public interface BitStreamReader
extends java.io.Closeable
```
An interface for a bit stream reader 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.
`long`	`getBufferBitSize()` Gets size of the underlying buffer in bits.
`int`	`getBytePosition()` Gets the current byte position.
`java.math.BigInteger`	`readBigInteger(int numBits)` Reads the next unsigned Big Integer value with containing numBits bits.
`BitBuffer`	`readBitBuffer()` Reads a bit buffer from the bit stream.
`long`	`readBits(int numBits)` Reads the next numBits of the bit stream as long value.
`boolean`	`readBool()` Reads a Boolean value from the bit stream.
`byte`	`readByte()` Reads the next signed byte (8 bits).
`byte[]`	`readBytes()` Reads a Zserio bytes from the bit stream.
`float`	`readFloat16()` Reads the a float16 value from the bit stream.
`float`	`readFloat32()` Reads the a float32 value from the bit stream.
`double`	`readFloat64()` Reads the a float64 value from the bit stream.
`int`	`readInt()` Reads the next signed integer (32 bits).
`long`	`readLong()` Reads the next signed long (64 bits).
`short`	`readShort()` Reads the next signed short (16 bits).
`java.math.BigInteger`	`readSignedBigInteger(int numBits)` Reads the next signed big Integer value with containing numBits bits.
`long`	`readSignedBits(int numBits)` Reads the next numBits as signed bit value.
`java.lang.String`	`readString()` Reads a Zserio string from the bit stream assuming it is encoded in UTF-8.
`short`	`readUnsignedByte()` Reads the next unsigned byte (8 bits) as short value.
`long`	`readUnsignedInt()` Reads the next unsigned integer (32 bits) as long value.
`int`	`readUnsignedShort()` Read the next unsigned short (16 bits) as int value.
`long`	`readVarInt()` Reads a signed variable integer from the bit stream.
`short`	`readVarInt16()` Reads a variable 16 bit integer from the bit stream.
`int`	`readVarInt32()` Reads a variable 32 bit integer from the bit stream.
`long`	`readVarInt64()` Reads a variable 64 bit integer from the bit stream.
`int`	`readVarSize()` Reads a variable size integer from the bit stream.
`java.math.BigInteger`	`readVarUInt()` Reads an unsigned variable integer from the bit stream.
`short`	`readVarUInt16()` Reads an unsigned variable 16 bit integer from the bit stream.
`int`	`readVarUInt32()` Reads an unsigned variable 32 bit integer from the bit stream.
`long`	`readVarUInt64()` Reads an unsigned variable 64 bit integer from the bit stream.
`void`	`setBitPosition(long position)` Sets the bit position to the given value.

Methods inherited from interface java.io.Closeable
close

- Method Detail
  - readSignedBits
```
long readSignedBits(int numBits)
             throws java.io.IOException
```
    Reads the next numBits as signed bit value.
    
    Parameters:
    
    numBits - Number of bits to read.
    
    Returns:
    
    Read signed bit value.
    
    Throws:
    
    java.io.IOException - If reading failed.
  - readBits
```
long readBits(int numBits)
       throws java.io.IOException
```
    Reads the next numBits of the bit stream as long value.
    
    Parameters:
    
    numBits - Number of bits to read.
    
    Returns:
    
    Read numBits value.
    
    Throws:
    
    java.io.IOException - If reading failed.
  - readByte
```
byte readByte()
       throws java.io.IOException
```
    Reads the next signed byte (8 bits).
    
    Returns:
    
    Read signed byte value.
    
    Throws:
    
    java.io.IOException - If reading failed.
  - readUnsignedByte
```
short readUnsignedByte()
                throws java.io.IOException
```
    Reads the next unsigned byte (8 bits) as short value.
    
    Returns:
    
    Read unsigned byte value.
    
    Throws:
    
    java.io.IOException - If reading failed.
  - readShort
```
short readShort()
         throws java.io.IOException
```
    Reads the next signed short (16 bits).
    
    Returns:
    
    Read signed short value.
    
    Throws:
    
    java.io.IOException - If reading failed.
  - readUnsignedShort
```
int readUnsignedShort()
               throws java.io.IOException
```
    Read the next unsigned short (16 bits) as int value.
    
    Returns:
    
    Read unsigned short value.
    
    Throws:
    
    java.io.IOException - If reading failed.
  - readInt
```
int readInt()
     throws java.io.IOException
```
    Reads the next signed integer (32 bits).
    
    Returns:
    
    Read signed integer value.
    
    Throws:
    
    java.io.IOException - If reading failed.
  - readUnsignedInt
```
long readUnsignedInt()
              throws java.io.IOException
```
    Reads the next unsigned integer (32 bits) as long value.
    
    Returns:
    
    Read unsigned integer value.
    
    Throws:
    
    java.io.IOException - If reading failed.
  - readLong
```
long readLong()
       throws java.io.IOException
```
    Reads the next signed long (64 bits).
    
    Returns:
    
    Read signed long value.
    
    Throws:
    
    java.io.IOException - If reading failed.
  - readBigInteger
```
java.math.BigInteger readBigInteger(int numBits)
                             throws java.io.IOException
```
    Reads the next unsigned Big Integer value with containing numBits bits.
    
    Parameters:
    
    numBits - Number of bits to read.
    
    Returns:
    
    Read big integer with the given bits.
    
    Throws:
    
    java.io.IOException - If reading failed.
  - readSignedBigInteger
```
java.math.BigInteger readSignedBigInteger(int numBits)
                                   throws java.io.IOException
```
    Reads the next signed big Integer value with containing numBits bits.
    
    Parameters:
    
    numBits - Number of bits to read.
    
    Returns:
    
    Read big integer with the given bits.
    
    Throws:
    
    java.io.IOException - If reading failed.
  - readFloat16
```
float readFloat16()
           throws java.io.IOException
```
    Reads the a float16 value from the bit stream.
    
    Returns:
    
    Read half precision float value.
    
    Throws:
    
    java.io.IOException - If reading failed.
  - readFloat32
```
float readFloat32()
           throws java.io.IOException
```
    Reads the a float32 value from the bit stream.
    
    Returns:
    
    Read single precision float value.
    
    Throws:
    
    java.io.IOException - If reading failed.
  - readFloat64
```
double readFloat64()
            throws java.io.IOException
```
    Reads the a float64 value from the bit stream.
    
    Returns:
    
    Read double precision float value.
    
    Throws:
    
    java.io.IOException - If reading failed.
  - readBytes
```
byte[] readBytes()
          throws java.io.IOException
```
    Reads a Zserio bytes from the bit stream.
    
    Returns:
    
    Read Zserio bytes as byte[].
    
    Throws:
    
    java.io.IOException - If reading failed.
  - readString
```
java.lang.String readString()
                     throws java.io.IOException
```
    Reads a Zserio string from the bit stream assuming it is encoded in UTF-8.
    
    Returns:
    
    Read Zserio string.
    
    Throws:
    
    java.io.IOException - If reading failed.
  - readBool
```
boolean readBool()
          throws java.io.IOException
```
    Reads a Boolean value from the bit stream.
    
    Returns:
    
    Read boolean value.
    
    Throws:
    
    java.io.IOException - If reading failed.
  - readVarInt16
```
short readVarInt16()
            throws java.io.IOException
```
    Reads a variable 16 bit integer from the bit stream.
    
    Returns:
    
    Read VarInt16 value.
    
    Throws:
    
    java.io.IOException - If reading failed.
  - readVarInt32
```
int readVarInt32()
          throws java.io.IOException
```
    Reads a variable 32 bit integer from the bit stream.
    
    Returns:
    
    Read VarInt32 value.
    
    Throws:
    
    java.io.IOException - If reading failed.
  - readVarInt64
```
long readVarInt64()
           throws java.io.IOException
```
    Reads a variable 64 bit integer from the bit stream.
    
    Returns:
    
    Read VarInt64 value.
    
    Throws:
    
    java.io.IOException - If reading failed.
  - readVarUInt16
```
short readVarUInt16()
             throws java.io.IOException
```
    Reads an unsigned variable 16 bit integer from the bit stream.
    
    Returns:
    
    Read unsigned VarUInt16 value.
    
    Throws:
    
    java.io.IOException - If reading failed.
  - readVarUInt32
```
int readVarUInt32()
           throws java.io.IOException
```
    Reads an unsigned variable 32 bit integer from the bit stream.
    
    Returns:
    
    Read unsigned VarUInt32 value.
    
    Throws:
    
    java.io.IOException - If reading failed.
  - readVarUInt64
```
long readVarUInt64()
            throws java.io.IOException
```
    Reads an unsigned variable 64 bit integer from the bit stream.
    
    Returns:
    
    Read unsigned VarUInt64 value.
    
    Throws:
    
    java.io.IOException - If reading failed.
  - readVarInt
```
long readVarInt()
         throws java.io.IOException
```
    Reads a signed variable integer from the bit stream. The integer takes up to 9 bytes to cover range <-2^63, 2^63-1>.
    
    Returns:
    
    Read signed VarInt value.
    
    Throws:
    
    java.io.IOException - If reading failed.
  - readVarUInt
```
java.math.BigInteger readVarUInt()
                          throws java.io.IOException
```
    Reads an unsigned variable integer from the bit stream. The integer takes up to 9 bytes to cover range <0, 2^64-1>.
    
    Returns:
    
    Read unsigned VarUInt value.
    
    Throws:
    
    java.io.IOException - If reading failed.
  - readVarSize
```
int readVarSize()
         throws java.io.IOException
```
    Reads a variable size integer from the bit stream.
    
    Returns:
    
    Read VarSize value.
    
    Throws:
    
    java.io.IOException - If reading failed.
  - readBitBuffer
```
BitBuffer readBitBuffer()
                 throws java.io.IOException
```
    Reads a bit buffer from the bit stream.
    
    Returns:
    
    Read bit buffer.
    
    Throws:
    
    java.io.IOException - If reading 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.
  - getBufferBitSize
```
long getBufferBitSize()
```
    Gets size of the underlying buffer in bits.
    
    Returns:
    
    Buffer bit size.

Interface BitStreamReader

Method Summary

Methods inherited from interface java.io.Closeable

Method Detail

readSignedBits

readBits

readByte

readUnsignedByte

readShort

readUnsignedShort

readInt

readUnsignedInt

readLong

readBigInteger

readSignedBigInteger

readFloat16

readFloat32

readFloat64

readBytes

readString

readBool

readVarInt16

readVarInt32

readVarInt64

readVarUInt16

readVarUInt32

readVarUInt64

readVarInt

readVarUInt

readVarSize

readBitBuffer

getBitPosition

getBytePosition

setBitPosition

alignTo

getBufferBitSize