zserio.runtime.array

Class ArrayTraits.BytesArrayTraits

java.lang.Object

zserio.runtime.array.ArrayTraits.BytesArrayTraits

All Implemented Interfaces:

ArrayTraits

Enclosing interface:

ArrayTraits

public static final class ArrayTraits.BytesArrayTraits
extends java.lang.Object
implements ArrayTraits

Array traits for zserio bytes arrays which are mapped to Java byte[][] 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
BytesArrayTraits()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

BytesArrayTraits

public BytesArrayTraits()

Method Detail

getPackedArrayTraits

public PackedArrayTraits getPackedArrayTraits()

Description copied from interface: ArrayTraits

Gets packed array traits.

Specified by:

getPackedArrayTraits in interface ArrayTraits

Returns:

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

isBitSizeOfConstant

public boolean isBitSizeOfConstant()

Description copied from interface: ArrayTraits

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

Specified by:

isBitSizeOfConstant in interface ArrayTraits

Returns:

true if bit size of the array elements is constant.

bitSizeOf

public int bitSizeOf(long bitPosition,
                     ArrayElement element)

Description copied from interface: ArrayTraits

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

Specified by:

bitSizeOf in interface ArrayTraits

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

public long initializeOffsets(long bitPosition,
                              ArrayElement element)

Description copied from interface: ArrayTraits

Initializes indexed offsets for the array element.

Specified by:

initializeOffsets in interface ArrayTraits

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 read(BitStreamReader reader,
                         int index)
                  throws java.io.IOException

Description copied from interface: ArrayTraits

Reads the array element from the bit stream.

Specified by:

read in interface ArrayTraits

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

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

Description copied from interface: ArrayTraits

Writes the array element to the bit stream.

Specified by:

write in interface ArrayTraits

Parameters:

writer - Bit stream write to write to.

element - Array element.

Throws:

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