zserio.runtime.array

Interface RawArray

All Known Implementing Classes:

RawArray.BigIntegerRawArray, RawArray.BitBufferRawArray, RawArray.BooleanRawArray, RawArray.ByteRawArray, RawArray.BytesRawArray, RawArray.DoubleRawArray, RawArray.EnumRawArray, RawArray.FloatRawArray, RawArray.IntRawArray, RawArray.LongRawArray, RawArray.ObjectRawArray, RawArray.ShortRawArray, RawArray.StringRawArray

public interface RawArray

Interface for classes which holds raw array. This interface gives the same abstraction for Java native arrays of primitive types like int[] and for Java native arrays of objects. Using the Java native arrays for primitive types is preferred because ArrayList of primitive types wrapper like Integer brings performance penalty during boxing/unboxing.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RawArray.BigIntegerRawArray Raw array for Java native array of BigIntegers.
static class	RawArray.BitBufferRawArray Raw array for Java native array of BitBuffer.
static class	RawArray.BooleanRawArray Raw array for Java native array of booleans.
static class	RawArray.ByteRawArray Raw array for Java native array of bytes.
static class	RawArray.BytesRawArray Raw array for Java native array of bytes.
static class	RawArray.DoubleRawArray Raw array for Java native array of doubles.
static class	RawArray.EnumRawArray<E extends ZserioEnum & SizeOf> Raw array for Java native array of enums.
static class	RawArray.FloatRawArray Raw array for Java native array of floats.
static class	RawArray.IntRawArray Raw array for Java native array of ints.
static class	RawArray.LongRawArray Raw array for Java native array of longs.
static class	RawArray.ObjectRawArray<E extends SizeOf> Raw array for Java native array of objects.
static class	RawArray.ShortRawArray Raw array for Java native array of shorts.
static class	RawArray.StringRawArray Raw array for Java native array of Strings.

Method Summary

Modifier and Type	Method and Description
ArrayElement	getElement(int index) Gets the raw array element.
<T> T	getRawArray() Gets the underlying raw array.
void	reset(int capacity) Resets the raw array.
void	setElement(ArrayElement element, int index) Sets the raw array element.
int	size() Gets the raw array size.

Method Detail

size

int size()

Gets the raw array size.

Returns:

Number of elements stored in the raw array.

reset

void reset(int capacity)

Resets the raw array.

Parameters:

capacity - Desired capacity of the raw array after reset.

getRawArray

<T> T getRawArray()

Gets the underlying raw array.

Type Parameters:

T - Java array type to be returned.

Returns:

The underlying raw array.

setElement

void setElement(ArrayElement element,
                int index)

Sets the raw array element.

Parameters:

element - Raw array element to set.

index - Index of element to set.

getElement

ArrayElement getElement(int index)

Gets the raw array element.

Parameters:

index - Index of element.

Returns:

The raw array element.