Package org.checkerframework.common.value.qual

Annotation Interface ArrayLen

@Documented @Retention(RUNTIME) @Target({TYPE_PARAMETER,TYPE_USE}) @SubtypeOf(UnknownVal.class) public @interface ArrayLen
An annotation indicating the length of an array or a string. If an expression's type has this annotation, then at run time, the expression evaluates to an array or a string whose length is one of the annotation's arguments.

For example, String @ArrayLen(2) [] is the type for an array of two strings, and String @ArrayLen({1, 2, 4, 8}) [] is the type for an array that contains 1, 2, 4, or 8 strings.

See the Checker Framework Manual:
Constant Value Checker

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    int[]
    value
    The possible lengths of the array.

  • Element Details

    • value

      int[] value
      The possible lengths of the array.