net.openhft.chronicle.bytes.internal

Class BytesFieldInfo

java.lang.Object

net.openhft.chronicle.bytes.internal.BytesFieldInfo

public class BytesFieldInfo
extends Object

This class holds the metadata information for fields within an object that are annotated with FieldGroup. It provides utilities for analyzing and grouping the fields based on their annotations, calculating the memory offset positions, and determining the size occupied by each group of fields.

The class is particularly useful for understanding and manipulating the layout of fields within an object in memory.

Example usage might include serialization, memory analysis, or direct memory access.

See Also:

FieldGroup

Method Summary

Modifier and Type	Method and Description
int	description() Returns the description metadata.
String	dump() Generates a string representation of the field groups within the object.
static List<Field>	fields(Class<?> clazz) Retrieves all non-static fields from the given class and its superclasses, sorted by their memory offsets.
Set<String>	groups() Returns a set of group names extracted from the field annotations.
long	lengthOf(String groupName) Returns the total memory size in bytes occupied by the group with the given name.
static BytesFieldInfo	lookup(Class<?> aClass) Retrieves the BytesFieldInfo instance for the given class from the cache.
long	startOf(String groupName) Returns the starting memory offset for the group with the given name.

Methods inherited from class java.lang.Object

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

Method Detail

description

public int description()

Returns the description metadata.

Returns:

an integer representing the description metadata

lookup

public static BytesFieldInfo lookup(Class<?> aClass)

Retrieves the BytesFieldInfo instance for the given class from the cache.

Parameters:

aClass - the class to look up

Returns:

the cached BytesFieldInfo instance for the given class

groups

public Set<String> groups()

Returns a set of group names extracted from the field annotations.

Returns:

a set of group names

startOf

public long startOf(String groupName)

Returns the starting memory offset for the group with the given name.

Parameters:

groupName - the name of the group

Returns:

the starting memory offset

Throws:

IllegalArgumentException - if no group with the given name is found

lengthOf

public long lengthOf(String groupName)

Returns the total memory size in bytes occupied by the group with the given name.

Parameters:

groupName - the name of the group

Returns:

the size of the group in bytes

Throws:

IllegalArgumentException - if no group with the given name is found

dump

public String dump()

Generates a string representation of the field groups within the object.

Returns:

a string representation of the field groups

fields

public static List<Field> fields(Class<?> clazz)

Retrieves all non-static fields from the given class and its superclasses, sorted by their memory offsets.

Parameters:

clazz - the class from which to retrieve the fields

Returns:

a sorted list of fields