Package org.checkerframework.framework.qual

Annotation Interface RequiresQualifier

@Documented @Retention(RUNTIME) @Target({METHOD,CONSTRUCTOR}) @Repeatable(List.class) public @interface RequiresQualifier
A precondition annotation to indicate that a method requires certain expressions to have a certain qualifier at the time of the call to the method. The expressions for which the annotation must hold after the method's execution are indicated by expression and are specified using a string. The qualifier is specified by qualifier.
See the Checker Framework Manual:
Syntax of Java expressions

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static @interface 
    RequiresQualifier.List
    A wrapper annotation that makes the RequiresQualifier annotation repeatable.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String[]
    expression
    Returns the Java expressions for which the annotation need to be present.
    Class<? extends Annotation>
    qualifier
    Returns the qualifier that is required.

  • Element Details

    • expression

      String[] expression
      Returns the Java expressions for which the annotation need to be present.
      Returns:
      the Java expressions for which the annotation need to be present
      See the Checker Framework Manual:
      Syntax of Java expressions

    • qualifier

      Class<? extends Annotation> qualifier
      Returns the qualifier that is required.
      Returns:
      the qualifier that is required