net.openhft.chronicle.core.annotation

Annotation Type NonNegative

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

@NonNegative declares that the annotated value must be zero or positive. It aids library maintainers and analysis tools in enforcing numerical contracts.

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

@NonNegative long size;

Sign-related annotations

Annotation	Constraint
Negative	val < 0
NonPositive	val <= 0
@NonNegative	val >= 0
Positive	val > 0

 void setSize(@NonNegative int size) {
     assert size >= 0;
 }
 

These annotations are advisory and may be enforced with ChronicleAssertions or Java assert.

See Also:

Negative, NonPositive, Positive, Range

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 must have a non-negative value.

Element Detail

value

public abstract String value

Specifies an optional comment to provide additional context or rationale for why the annotated element must have a non-negative value.

Returns:

the comment explaining why this constraint is necessary

Default:

""