net.openhft.chronicle.core.annotation

Annotation Type Positive

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

Annotation that indicates the annotated element is expected to hold a positive value (i.e. val > 0). This can be applied to methods, fields, parameters, local variables, and types to specify constraints or document the intended usage.

See Also:

Negative, NonNegative, NonPositive

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 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 positive value.

Returns:

the comment explaining why this constraint is necessary

Default:

""