zserio.runtime.array

Class ArrayTraits.BitFieldBigIntegerArrayTraits

java.lang.Object

zserio.runtime.array.ArrayTraits.IntegralArrayTraitsBase

zserio.runtime.array.ArrayTraits.BitFieldBigIntegerArrayTraits

All Implemented Interfaces:

ArrayTraits, ArrayTraits.IntegralArrayTraits

Enclosing interface:

ArrayTraits

public static final class ArrayTraits.BitFieldBigIntegerArrayTraits
extends ArrayTraits.IntegralArrayTraitsBase

Array traits for zserio uint64, bit:64 and dynamic bit field arrays which are mapped to Java BigInteger[] array.

Nested Class Summary

Nested classes/interfaces inherited from interface zserio.runtime.array.ArrayTraits

ArrayTraits.BitBufferArrayTraits, ArrayTraits.BitFieldBigIntegerArrayTraits, ArrayTraits.BitFieldByteArrayTraits, ArrayTraits.BitFieldIntArrayTraits, ArrayTraits.BitFieldLongArrayTraits, ArrayTraits.BitFieldShortArrayTraits, ArrayTraits.BoolArrayTraits, ArrayTraits.BytesArrayTraits, ArrayTraits.Float16ArrayTraits, ArrayTraits.Float32ArrayTraits, ArrayTraits.Float64ArrayTraits, ArrayTraits.IntegralArrayTraits, ArrayTraits.IntegralArrayTraitsBase, ArrayTraits.ObjectArrayTraits<E extends SizeOf>, ArrayTraits.PackableObjectArrayTraits<E extends PackableSizeOf>, ArrayTraits.SignedBitFieldByteArrayTraits, ArrayTraits.SignedBitFieldIntArrayTraits, ArrayTraits.SignedBitFieldLongArrayTraits, ArrayTraits.SignedBitFieldShortArrayTraits, ArrayTraits.StringArrayTraits, ArrayTraits.VarInt16ArrayTraits, ArrayTraits.VarInt32ArrayTraits, ArrayTraits.VarInt64ArrayTraits, ArrayTraits.VarIntArrayTraits, ArrayTraits.VarSizeArrayTraits, ArrayTraits.VarUInt16ArrayTraits, ArrayTraits.VarUInt32ArrayTraits, ArrayTraits.VarUInt64ArrayTraits, ArrayTraits.VarUIntArrayTraits, ArrayTraits.WriteObjectArrayTraits<E extends Writer & SizeOf>, ArrayTraits.WritePackableObjectArrayTraits<E extends PackableWriter & PackableSizeOf>

Constructor Summary

Constructors

Constructor and Description
BitFieldBigIntegerArrayTraits(int numBits) Constructor from number of bits of zserio type.

Method Summary

Modifier and Type	Method and Description
int	bitSizeOf(ArrayElement element) Gets the bit size of the array element if it is stored in the bit stream.
ArrayElement.IntegralArrayElement	fromBigInteger(java.math.BigInteger bigInteger) Creates integral array element from given big integer value.
long	initializeOffsets(long bitPosition, ArrayElement element) Initializes indexed offsets for the array element.
boolean	isBitSizeOfConstant() Checks if bit size of the array elements is always the same.
ArrayElement.IntegralArrayElement	read(BitStreamReader reader) Reads the array element from the bit stream.
void	write(BitStreamWriter writer, ArrayElement element) Writes the array element to the bit stream.

Methods inherited from class zserio.runtime.array.ArrayTraits.IntegralArrayTraitsBase

bitSizeOf, getPackedArrayTraits, read

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BitFieldBigIntegerArrayTraits

public BitFieldBigIntegerArrayTraits(int numBits)

Constructor from number of bits of zserio type.

Parameters:

numBits - Number of bits of zserio type.

Method Detail

isBitSizeOfConstant

public boolean isBitSizeOfConstant()

Description copied from interface: ArrayTraits

Checks if bit size of the array elements is always the same.

Returns:

true if bit size of the array elements is constant.

bitSizeOf

public int bitSizeOf(ArrayElement element)

Description copied from interface: ArrayTraits.IntegralArrayTraits

Gets the bit size of the array element if it is stored in the bit stream.

Parameters:

element - Array element.

Returns:

Bit size of the given array element if it is stored in the bit stream.

initializeOffsets

public long initializeOffsets(long bitPosition,
                              ArrayElement element)

Description copied from interface: ArrayTraits

Initializes indexed offsets for the array element.

Parameters:

bitPosition - Current bit position in the bit stream.

element - Array element.

Returns:

Updated bit stream position which points to the first bit after the array element.

read

public ArrayElement.IntegralArrayElement read(BitStreamReader reader)
                                       throws java.io.IOException

Description copied from interface: ArrayTraits.IntegralArrayTraits

Reads the array element from the bit stream.

Parameters:

reader - Bit stream reader to read from.

Returns:

Array element filled by read element.

Throws:

java.io.IOException - Failure during bit stream manipulation.

write

public void write(BitStreamWriter writer,
                  ArrayElement element)
           throws java.io.IOException

Description copied from interface: ArrayTraits

Writes the array element to the bit stream.

Parameters:

writer - Bit stream write to write to.

element - Array element.

Throws:

java.io.IOException - Failure during bit stream manipulation.

fromBigInteger

public ArrayElement.IntegralArrayElement fromBigInteger(java.math.BigInteger bigInteger)

Description copied from interface: ArrayTraits.IntegralArrayTraits

Creates integral array element from given big integer value.

Parameters:

bigInteger - Big integer value of the element to create.

Returns:

Integral array element.