net.openhft.chronicle.core.annotation

Annotation Type Range

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

Indicates that the annotated element is expected to hold a value within a specified range [from, to), where the "from" value is inclusive and the "to" value is exclusive (i.e. from <= val < to).

Note that this annotation cannot be used to represent an inclusive upper bound of Long.MAX_VALUE.

This annotation can be applied to methods, fields, parameters, local variables, and types to enforce or document the range constraints for the values they hold.

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