zserio.runtime.validation

Class ValidationBitStreamReader

java.lang.Object

zserio.runtime.io.ByteArrayBitStreamReader

zserio.runtime.validation.ValidationBitStreamReader

All Implemented Interfaces:

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

public final class ValidationBitStreamReader
extends ByteArrayBitStreamReader

The bit stream reader used in validate() method generated by Zserio.

The validation bit stream reader records - a special 'AND' bit mask (invalidMaskBuffer) which contains '1' if corresponding bit in read buffer is not used for validation and - a special 'OR' bit mask (nanMaskBuffer) which constains normalized NaN values (NaNs used by writer).

Bits in reader do not have to be used for validation in the following situations: 1. If the bits have been skipped (not read) which can happen using Zserio 'align' command for example. 2. If NaN occurs. NaNs do not have unique binary representation and they must be normalized to NaNs used by writer.

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
ValidationBitStreamReader(byte[] bytes) Constructs a new ValidationBitStreamReader.

Method Summary

Modifier and Type	Method and Description
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.
int	getBitOffset() Gets the current bit offset.
long	getBitPosition() Gets the current bit position.
int	getBytePosition() Gets the current byte position.
float	readFloat16() Reads the a float16 value from the bit stream.
void	setBitPosition(long bitPosition) Sets the bit position to the given value.
byte[]	toMaskedByteArray() Returns the read byte array with unused bits set to zero and with 'normalized' NaNs.

Methods inherited from class zserio.runtime.io.ByteArrayBitStreamReader

alignTo, close, getBuffer, getBufferBitSize, readBigInteger, readBitBuffer, readBits, readBool, readByte, readBytes, readFloat32, readFloat64, readInt, readLong, readShort, readSignedBigInteger, readSignedBits, readString, readUnsignedByte, readUnsignedInt, readUnsignedShort, readVarInt, readVarInt16, readVarInt32, readVarInt64, readVarSize, readVarUInt, readVarUInt16, readVarUInt32, readVarUInt64

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

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

ValidationBitStreamReader

public ValidationBitStreamReader(byte[] bytes)

Constructs a new ValidationBitStreamReader.

Parameters:

bytes - Array of bytes to construct from.

Method Detail

toMaskedByteArray

public byte[] toMaskedByteArray()

Returns the read byte array with unused bits set to zero and with 'normalized' NaNs. 'Normalized' NaNs means NaNs with the same binary format as it is used by Java BitStreamWriter.

Returns:

Read byte array with masked unused bits.

setBitPosition

public void setBitPosition(long bitPosition)
                    throws java.io.IOException

Sets the bit position to the given value.

Specified by:

setBitPosition in interface BitStreamReader

Parameters:

bitPosition - Bit position to set.

Throws:

java.io.IOException - Throws in case of any error.

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

Overrides:

readFloat16 in class ByteArrayBitStreamReader

Returns:

Read half precision float value.

Throws:

java.io.IOException - If reading 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.

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.