Package org.checkerframework.framework.qual

Annotation Type 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

    • Required Element Summary

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

    • Element Detail

      • expression

        java.lang.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

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