Checker Qual 3.38.0 · org.checkerframework.checker.index.qual

Annotation Summary

Modifier and Type	Annotation and Description
public @interface	EnsuresLTLengthOf Indicates that the value expressions evaluate to an integer whose value is less than the lengths of all the given sequences, if the method terminates successfully.
public @interface	EnsuresLTLengthOfIf Indicates that the given expressions evaluate to an integer whose value is less than the lengths of all the given sequences, if the method returns the given result (either true or false).
public @interface	GTENegativeOne The annotated expression evaluates to an integer greater than or equal to -1.
public @interface	HasSubsequence The annotated sequence contains a subsequence that is equal to the value of some other expression.
public @interface	IndexFor An integer that can be used to index any of the given sequences.
public @interface	IndexOrHigh An integer that, for each of the given sequences, is either a valid index or is equal to the sequence's length.
public @interface	IndexOrLow An integer that is either -1 or is a valid index for each of the given sequences.
public @interface	LengthOf An integer that, for each of the given sequences, is equal to the sequence's length.
public @interface	LessThan An annotation indicating the relationship between values with a byte, short, char, int, or long type.
public @interface	LessThanBottom The bottom type in the LessThan type system.
public @interface	LessThanUnknown The top qualifier for the LessThan type hierarchy.
public @interface	LowerBoundBottom The bottom type of the lower bound type system.
public @interface	LowerBoundUnknown The annotated expression evaluates to value that might be -2 or lower.
public @interface	LTEqLengthOf The annotated expression evaluates to an integer whose value is less than or equal to the lengths of all the given sequences.
public @interface	LTLengthOf The annotated expression evaluates to an integer whose value is less than the lengths of all the given sequences.
public @interface	LTOMLengthOf The annotated expression evaluates to an integer whose value is at least 2 less than the lengths of all the given sequences.
public @interface	NegativeIndexFor The annotated expression is between `-1` and `-a.length - 1`, inclusive, for each sequence `a` listed in the annotation.
public @interface	NonNegative The annotated expression evaluates to an integer greater than or equal to 0.
public @interface	PolyIndex A polymorphic qualifier for the Lower Bound and Upper Bound type systems.
public @interface	PolyLength Syntactic sugar for both @PolyValue and @PolySameLen.
public @interface	PolyLowerBound A polymorphic qualifier for the Lower Bound type system.
public @interface	PolySameLen A polymorphic qualifier for the SameLen type system.
public @interface	PolyUpperBound A polymorphic qualifier for the Upper Bound type system.
public @interface	Positive The annotated expression evaluates to an integer greater than or equal to 1.
public @interface	SameLen An expression whose type has this annotation evaluates to a value that is a sequence, and that sequence has the same length as the given sequences.
public @interface	SameLenBottom The bottom type in the SameLen type system.
public @interface	SameLenUnknown This type represents any variable that isn't known to have the same length as another sequence.
public @interface	SearchIndexBottom The bottom type in the Search Index type system.
public @interface	SearchIndexFor The annotated expression evaluates to an integer whose length is between `-a.length - 1` and `a.length - 1`, inclusive, for all sequences `a` listed in the annotation.
public @interface	SearchIndexUnknown The top type for the SearchIndex type system.
public @interface	SubstringIndexBottom The bottom type in the Substring Index type system.
public @interface	SubstringIndexFor The annotated expression evaluates to either -1 or a non-negative integer less than the lengths of all the given sequences.
public @interface	SubstringIndexUnknown The top type for the Substring Index type system.
public @interface	UpperBoundBottom The bottom type in the Upper Bound type system.
public @interface	UpperBoundLiteral A literal value.
public @interface	UpperBoundUnknown A variable not known to have a relation to any sequence length.

Package org.checkerframework.checker.index.qual

Annotation Summary