net.openhft.chronicle.values

Annotation Type Array

@Target(value=METHOD)
 @Retention(value=RUNTIME)
 @Documented
public @interface Array

Specifies the properties of an array field: number of elements and their alignment. This annotation must be put on a single method accessing the array elements: getter, or setter, or adder, etc.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
int	length Specifies the array length, index in accessor methods should be between 0 and length - 1, just like for vanilla Java arrays.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	elementDontCrossAlignment Specifies boundary which elements' bytes shouldn't cross, see Align.dontCross().
int	elementOffsetAlignment Specifies the alignment of offsets of the elements, see Align for more information.

Element Detail

length

public abstract int length

Specifies the array length, index in accessor methods should be between 0 and length - 1, just like for vanilla Java arrays. This value should be positive.

elementOffsetAlignment

public abstract int elementOffsetAlignment

Specifies the alignment of offsets of the elements, see Align for more information. Elements' offsets alignment couldn't be more coarse than the offset alignment of the whole array field. The Align.DEFAULT value specifies the alignment dependent on the element type, if it is a Value generated interface, otherwise Align.NO_ALIGNMENT. Values less than -1 are not allowed.

Default:

-1

elementDontCrossAlignment

public abstract int elementDontCrossAlignment

Specifies boundary which elements' bytes shouldn't cross, see Align.dontCross(). Default is Align.NO_ALIGNMENT.

Default:

0