net.openhft.chronicle.core.annotation

Annotation Type Range

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

@Range asserts that a value falls within [from, to). It is aimed at library maintainers and static analysis tools that verify argument ranges.

Retention and effect: Stored in the class file. There is no runtime impact unless Chronicle tooling reads the metadata.

  @Range(from = 0, to = 10)
 int level;
 

Limitations: Using Long.MAX_VALUE as to() can lead to overflow. Use Long.MAX_VALUE - 1 when an inclusive upper bound is required.

This annotation is also used by Chronicle-Values for bit-packing to optimise memory layout. The to() value is exclusive by default.

See Also:

Positive, Negative, NonNegative, NonPositive

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
long	from Specifies the lower bound of the range.
long	to Specifies the upper bound of the range.
String	value Specifies an optional comment to provide additional context or rationale for why the annotated element must be within the specified range.

Element Detail

value

public abstract String value

Specifies an optional comment to provide additional context or rationale for why the annotated element must be within the specified range.

Returns:

the comment explaining why this range constraint is necessary

Default:

""

from

public abstract long from

Specifies the lower bound of the range. The annotated element is expected to hold a value that is greater than or equal to this "from" value.

Returns:

the inclusive lower bound of the range

Default:

-9223372036854775808L

to

public abstract long to

Specifies the upper bound of the range. The annotated element is expected to hold a value that is strictly less than this "to" value.

Returns:

the exclusive upper bound of the range

Default:

9223372036854775807L