zserio.runtime.array

Class Array

java.lang.Object

zserio.runtime.array.Array

public final class Array
extends java.lang.Object

Array wrapper which is used for mapping of all zserio arrays. Array wrapper is defined by: - raw array - array traits which define zserio methods for array elements of corresponding Java native types - array type (normal, auto, implicit) - offset initializer to set offsets for indexed offsets arrays - offset checker to check offsets for indexed offsets arrays

Constructor Summary

Constructors

Constructor and Description
Array(RawArray rawArray, ArrayTraits arrayTraits, ArrayType arrayType) Constructor.
Array(RawArray rawArray, ArrayTraits arrayTraits, ArrayType arrayType, OffsetChecker offsetChecker) Constructor.
Array(RawArray rawArray, ArrayTraits arrayTraits, ArrayType arrayType, OffsetChecker offsetChecker, OffsetInitializer offsetInitializer) Constructor.

Method Summary

Modifier and Type	Method and Description
int	bitSizeOf(long bitPosition) Gets the bit size of the array if it is stored in the bit stream.
int	bitSizeOfPacked(long bitPosition) Returns length of the packed array stored in the bit stream in bits.
boolean	equals(java.lang.Object obj)
<T> T	getRawArray() Gets the underlying raw array.
int	hashCode()
long	initializeOffsets(long bitPosition) Initializes indexed offsets for the array.
long	initializeOffsetsPacked(long bitPosition) Initializes indexed offsets for the packed array.
void	read(BitStreamReader reader) Reads the array from the bit stream.
void	read(BitStreamReader reader, int size) Reads the array from the bit stream.
void	readPacked(BitStreamReader reader) Reads packed array from the bit stream.
void	readPacked(BitStreamReader reader, int size) Reads packed array from the bit stream.
int	size() Gets the underlying raw array size.
void	write(BitStreamWriter writer) Writes the array element to the bit stream.
void	writePacked(BitStreamWriter writer) Writes packed array to the bit stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

Array

public Array(RawArray rawArray,
             ArrayTraits arrayTraits,
             ArrayType arrayType)

Constructor.

Parameters:

rawArray - Raw array to construct from.

arrayTraits - Array traits to construct from.

arrayType - Array type to construct from.

Array

public Array(RawArray rawArray,
             ArrayTraits arrayTraits,
             ArrayType arrayType,
             OffsetChecker offsetChecker)

Constructor.

Parameters:

rawArray - Raw array to construct from.

arrayTraits - Array traits to construct from.

arrayType - Array type to construct from.

offsetChecker - Offset checker to construct from.

Array

public Array(RawArray rawArray,
             ArrayTraits arrayTraits,
             ArrayType arrayType,
             OffsetChecker offsetChecker,
             OffsetInitializer offsetInitializer)

Constructor.

Parameters:

rawArray - Raw array to construct from.

arrayTraits - Array traits to construct from.

arrayType - Array type to construct from.

offsetChecker - Offset checker to construct from.

offsetInitializer - Offset initializer to construct from.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getRawArray

public <T> T getRawArray()

Gets the underlying raw array.

Type Parameters:

T - Java array type to be returned.

Returns:

Underlying raw array.

size

public int size()

Gets the underlying raw array size.

Returns:

The number of elements stored in the underlying raw array.

bitSizeOf

public int bitSizeOf(long bitPosition)

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

Parameters:

bitPosition - Current bit position in the bit stream.

Returns:

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

bitSizeOfPacked

public int bitSizeOfPacked(long bitPosition)

Returns length of the packed array stored in the bit stream in bits.

Parameters:

bitPosition - Current bit stream position.

Returns:

Length of the array stored in the bit stream in bits.

initializeOffsets

public long initializeOffsets(long bitPosition)

Initializes indexed offsets for the array.

Parameters:

bitPosition - Current bit position in the bit stream.

Returns:

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

initializeOffsetsPacked

public long initializeOffsetsPacked(long bitPosition)

Initializes indexed offsets for the packed array.

Parameters:

bitPosition - Current bit stream position.

Returns:

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

read

public void read(BitStreamReader reader)
          throws java.io.IOException

Reads the array from the bit stream.

Parameters:

reader - Bit stream reader to read from.

Throws:

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

read

public void read(BitStreamReader reader,
                 int size)
          throws java.io.IOException

Reads the array from the bit stream.

Parameters:

reader - Bit stream reader to read from.

size - Number of elements stored in the array which shall be read.

Throws:

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

readPacked

public void readPacked(BitStreamReader reader)
                throws java.io.IOException

Reads packed array from the bit stream. This method has all possible arguments and from generated code is used for aligned object arrays.

Parameters:

reader - Bit stream from which to read.

Throws:

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

readPacked

public void readPacked(BitStreamReader reader,
                       int size)
                throws java.io.IOException

Reads packed array from the bit stream. This method has all possible arguments and from generated code is used for aligned object arrays.

Parameters:

reader - Bit stream from which to read.

size - Number of elements to read.

Throws:

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

write

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

Writes the array element to the bit stream.

Parameters:

writer - Bit stream write to write to.

Throws:

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

writePacked

public void writePacked(BitStreamWriter writer)
                 throws java.io.IOException

Writes packed array to the bit stream.

Parameters:

writer - Bit stream where to write.

Throws:

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