zserio.runtime.array

Interface PackedArrayTraits

All Known Implementing Classes:

PackedArrayTraits.IntegralPackedArrayTraits, PackedArrayTraits.ObjectPackedArrayTraits, PackedArrayTraits.WriteObjectPackedArrayTraits

public interface PackedArrayTraits

Interface for packed array traits.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PackedArrayTraits.IntegralPackedArrayTraits Packed array traits for arrays of integral types.
static class	PackedArrayTraits.ObjectPackedArrayTraits<E extends PackableSizeOf> Packed array traits for zserio object arrays (without writer part).
static class	PackedArrayTraits.WriteObjectPackedArrayTraits<E extends PackableWriter & PackableSizeOf> Packed array traits for zserio object arrays (with writer part).

Method Summary

Modifier and Type	Method and Description
int	bitSizeOf(PackingContext context, long bitPosition, ArrayElement element) Returns length of the array element stored in the bit stream in bits.
PackingContext	createContext() Creates packing context.
void	initContext(PackingContext context, ArrayElement element) Calls context initialization step for the current element.
long	initializeOffsets(PackingContext context, long bitPosition, ArrayElement element) Calls indexed offsets initialization for the current element.
ArrayElement	read(PackingContext context, BitStreamReader reader, int index) Reads an element from the bit stream.
void	write(PackingContext context, BitStreamWriter writer, ArrayElement element) Writes the element to the bit stream.

Method Detail

createContext

PackingContext createContext()

Creates packing context.

Returns:

Packing context node with the created context.

initContext

void initContext(PackingContext context,
                 ArrayElement element)

Calls context initialization step for the current element.

Parameters:

context - Packing context node which keeps the context.

element - Current element.

bitSizeOf

int bitSizeOf(PackingContext context,
              long bitPosition,
              ArrayElement element)

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

Parameters:

context - Packing context node.

bitPosition - Current bit stream position.

element - Current element.

Returns:

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

initializeOffsets

long initializeOffsets(PackingContext context,
                       long bitPosition,
                       ArrayElement element)

Calls indexed offsets initialization for the current element.

Parameters:

context - Packing context node.

bitPosition - Current bit stream position.

element - Current element.

Returns:

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

read

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

Reads an element from the bit stream.

Parameters:

context - Packing context node.

reader - Bit stream reader.

index - Index of the current element.

Returns:

Read element.

Throws:

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

write

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

Writes the element to the bit stream.

Parameters:

context - Packing context node.

writer - Bit stream writer.

element - Element to write.

Throws:

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