org.checkerframework.checker.index.qual

Annotation Type LTEqLengthOf

@Documented
 @Retention(value=RUNTIME)
 @Target(value={TYPE_USE,TYPE_PARAMETER})
 @SubtypeOf(value=UpperBoundUnknown.class)
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. ("LTEq" stands for "Less than or equal to".)

For example, an expression with type @LTLengthOf({"a", "b"}) is less than or equal to both a.length and b.length. The sequences a and b might have different lengths.

@LTEqLengthOf({"a"}) = @LTLengthOf(value={"a"}, offset=-1), and
@LTEqLengthOf(value={"a"}, offset=x) = @LTLengthOf(value={"a"}, offset=x-1) for any x.

See the Checker Framework Manual:

Index Checker

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String[]	value Sequences, each of which is at least as long as the annotated expression's value.

Element Detail

value

@JavaExpression
public abstract String[] value

Sequences, each of which is at least as long as the annotated expression's value.