net.openhft.chronicle.core.annotation

Annotation Type NonPositive

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

@NonPositive signals that the annotated value must be zero or below. Library maintainers may use it to declare numeric constraints.

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

@NonPositive int offset;

Sign-related annotations

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

 void clear(@NonPositive int count) {
     assert count <= 0;
 }
 

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

See Also:

Negative, NonNegative, 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-positive 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-positive value.

Returns:

the comment explaining why this constraint is necessary

Default:

""