zserio.runtime.array

Interface ArrayTraits

All Known Subinterfaces:

ArrayTraits.IntegralArrayTraits

All Known Implementing Classes:

ArrayTraits.BitBufferArrayTraits, ArrayTraits.BitFieldBigIntegerArrayTraits, ArrayTraits.BitFieldByteArrayTraits, ArrayTraits.BitFieldIntArrayTraits, ArrayTraits.BitFieldLongArrayTraits, ArrayTraits.BitFieldShortArrayTraits, ArrayTraits.BoolArrayTraits, ArrayTraits.BytesArrayTraits, ArrayTraits.Float16ArrayTraits, ArrayTraits.Float32ArrayTraits, ArrayTraits.Float64ArrayTraits, ArrayTraits.IntegralArrayTraitsBase, ArrayTraits.ObjectArrayTraits, ArrayTraits.PackableObjectArrayTraits, 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, ArrayTraits.WritePackableObjectArrayTraits

public interface ArrayTraits

Interface for array traits. Array traits provides an implementation of zserio functions for one element given by index and raw array.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ArrayTraits.BitBufferArrayTraits Array traits for zserio extern bit buffer arrays which are mapped to Java BitBuffer[] array.
static class	ArrayTraits.BitFieldBigIntegerArrayTraits Array traits for zserio uint64, bit:64 and dynamic bit field arrays which are mapped to Java BigInteger[] array.
static class	ArrayTraits.BitFieldByteArrayTraits Array traits for zserio bit:1...bit:7 arrays which are mapped to Java byte[] array.
static class	ArrayTraits.BitFieldIntArrayTraits Array traits for zserio uint16 and bit:16...bit:31 arrays which are mapped to Java int[] array.
static class	ArrayTraits.BitFieldLongArrayTraits Array traits for zserio uint32 and bit:32...bit:63 arrays which are mapped to Java long[] array.
static class	ArrayTraits.BitFieldShortArrayTraits Array traits for zserio uint8 and bit:8...bit:15 arrays which are mapped to Java short[] array.
static class	ArrayTraits.BoolArrayTraits Array traits for zserio bool arrays which are mapped to Java boolean[] array.
static class	ArrayTraits.BytesArrayTraits Array traits for zserio bytes arrays which are mapped to Java byte[][] array.
static class	ArrayTraits.Float16ArrayTraits Array traits for zserio float16 arrays which are mapped to Java float[] array.
static class	ArrayTraits.Float32ArrayTraits Array traits for zserio float32 arrays which are mapped to Java float[] array.
static class	ArrayTraits.Float64ArrayTraits Array traits for zserio float64 arrays which are mapped to Java double[] array.
static interface	ArrayTraits.IntegralArrayTraits Interface for integral array traits.
static class	ArrayTraits.IntegralArrayTraitsBase Implementation of common integral array traits functionality.
static class	ArrayTraits.ObjectArrayTraits<E extends SizeOf> Array traits for zserio object arrays (without writer part) which are mapped to Java zserio object array.
static class	ArrayTraits.PackableObjectArrayTraits<E extends PackableSizeOf> Array traits for zserio packable object arrays (without writer part) which are mapped to Java zserio object array.
static class	ArrayTraits.SignedBitFieldByteArrayTraits Array traits for zserio int8 and int:1...int:8 arrays which are mapped to Java byte[] array.
static class	ArrayTraits.SignedBitFieldIntArrayTraits Array traits for zserio int32 and int:17...int:32 arrays which are mapped to Java int[] array.
static class	ArrayTraits.SignedBitFieldLongArrayTraits Array traits for zserio int64 and int:33...int:64 arrays which are mapped to Java long[] array.
static class	ArrayTraits.SignedBitFieldShortArrayTraits Array traits for zserio int16 and int:9...int:16 arrays which are mapped to Java short[] array.
static class	ArrayTraits.StringArrayTraits Array traits for zserio string arrays which are mapped to Java String[] array.
static class	ArrayTraits.VarInt16ArrayTraits Array traits for zserio varint16 arrays which are mapped to Java short[] array.
static class	ArrayTraits.VarInt32ArrayTraits Array traits for zserio varint32 arrays which are mapped to Java int[] array.
static class	ArrayTraits.VarInt64ArrayTraits Array traits for zserio varint64 arrays which are mapped to Java long[] array.
static class	ArrayTraits.VarIntArrayTraits Array traits for zserio varint arrays which are mapped to Java long[] array.
static class	ArrayTraits.VarSizeArrayTraits Array traits for zserio varsize arrays which are mapped to Java int[] array.
static class	ArrayTraits.VarUInt16ArrayTraits Array traits for zserio varuint16 arrays which are mapped to Java short[] array.
static class	ArrayTraits.VarUInt32ArrayTraits Array traits for zserio varuint32 arrays which are mapped to Java int[] array.
static class	ArrayTraits.VarUInt64ArrayTraits Array traits for zserio varuint64 arrays which are mapped to Java long[] array.
static class	ArrayTraits.VarUIntArrayTraits Array traits for zserio varuint arrays which are mapped to Java BigInteger[] array.
static class	ArrayTraits.WriteObjectArrayTraits<E extends Writer & SizeOf> Array traits for zserio object arrays (with writer part) which are mapped to Java zserio object array.
static class	ArrayTraits.WritePackableObjectArrayTraits<E extends PackableWriter & PackableSizeOf> Array traits for zserio packable object arrays (with writer part) which are mapped to Java zserio object array.

Method Summary

Modifier and Type	Method and Description
int	bitSizeOf(long bitPosition, ArrayElement element) Gets the bit size of the array element if it is stored in the bit stream.
PackedArrayTraits	getPackedArrayTraits() Gets packed array traits.
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	read(BitStreamReader reader, int index) Reads the array element from the bit stream.
void	write(BitStreamWriter writer, ArrayElement element) Writes the array element to the bit stream.

Method Detail

isBitSizeOfConstant

boolean isBitSizeOfConstant()

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

Returns:

true if bit size of the array elements is constant.

getPackedArrayTraits

PackedArrayTraits getPackedArrayTraits()

Gets packed array traits.

Returns:

Instance of packed array traits or null if the array is not packable.

bitSizeOf

int bitSizeOf(long bitPosition,
              ArrayElement element)

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

Parameters:

bitPosition - Current bit position in the bit stream.

element - Array element.

Returns:

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

initializeOffsets

long initializeOffsets(long bitPosition,
                       ArrayElement element)

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

ArrayElement read(BitStreamReader reader,
                  int index)
           throws java.io.IOException

Reads the array element from the bit stream.

Parameters:

reader - Bit stream reader to read from.

index - Index of the array element to read.

Returns:

Array element filled by read element.

Throws:

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

write

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

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.