net.openhft.chronicle.core.annotation

Annotation Type Address

@Retention(value=CLASS)
 @Target(value={METHOD,FIELD,PARAMETER,LOCAL_VARIABLE,TYPE_USE})
public @interface Address

@Address declares that the annotated value represents a native memory address or base pointer. It improves API semantics by distinguishing raw addresses from sizes, indexes, and object-relative offsets.

Retention and effect: Stored in the class file but ignored by the runtime unless Chronicle tooling checks it.

This annotation is semantic only. Use it alongside explicit range guards such as MemoryAegis.assertAddressRange(...) when a concrete access width or slice length is known.

  @Address long address;

 int readInt( @Address long address) {
     assert SKIP_ASSERTIONS || MemoryAegis.assertAddressRange(address, Integer.BYTES);
     return ...;
 }
 

See Also:

NonNegative

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	value Specifies an optional comment to provide additional context or rationale for why the annotated element represents a native address.

Element Detail

value

public abstract String value

Specifies an optional comment to provide additional context or rationale for why the annotated element represents a native address.

Returns:

the comment explaining why this address annotation is necessary

Default:

""