net.openhft.chronicle.bytes

Annotation Type FieldGroup

@Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface FieldGroup

Annotation used for logically grouping fields within a class. It is especially useful in classes where precise control over the memory layout of fields is required, or in scenarios where logically grouping related fields can simplify code that operates on these fields.

The FieldGroup annotation is retained at runtime and can be used to annotate fields within a class. The name of the group is specified through the 'value' method, allowing multiple fields to be associated with the same group by assigning them the same name.

One common use case is organizing the memory layout for serialization or memory-mapped objects where fields that are accessed together are placed adjacently in memory.

Example:

 public class Record {
     @FieldGroup("header")
     private int headerField1;

     @FieldGroup("header")
     private int headerField2;

     @FieldGroup("body")
     private int bodyField1, bodyField2;
 }
 

Field Summary

Fields

Modifier and Type	Fields and Description
static String	HEADER Deprecated.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value Defines the name of the field group.

Field Detail

HEADER

@Deprecated
public static final String HEADER

Deprecated.

Special FieldGroup that if it is present, must be at the start but is ignored.

Element Detail

value

public abstract String value

Defines the name of the field group. Multiple fields with the same value are considered part of the same logical group.

Returns:

the name of the group