ByteArrayBitStreamReader

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

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, BitStreamReader

Direct Known Subclasses:

ValidationBitStreamReader
```
public class ByteArrayBitStreamReader
extends java.lang.Object
implements BitStreamReader
```
A bit stream reader 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
`ByteArrayBitStreamReader(BitBuffer bitBuffer)` Constructs object using given bit buffer.
`ByteArrayBitStreamReader(byte[] bytes)` Constructs object containing given bytes with a given byte order.
`ByteArrayBitStreamReader(byte[] bytes, long bitSize)` Constructs object containing given bytes with a given byte order with exact bit size.

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.
`protected byte[]`	`getBuffer()` Gets the underlying buffer.
`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 bitPosition)` Sets the bit position to the given value.

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface zserio.runtime.io.BitStreamReader

Field Detail

bytePosition

bitOffset

DEFAULT_CHARSET_NAME

BYTE_MOD_MASK

Constructor Detail

ByteArrayBitStreamReader

ByteArrayBitStreamReader

ByteArrayBitStreamReader

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

alignTo

getBufferBitSize

close

getBuffer

getBitPosition

getBytePosition

setBitPosition

getBitOffset

checkRange

checkUnsignedRange