org.checkerframework.checker.calledmethods.qual.CalledMethodsPredicate Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of checker Show documentation

The Checker Framework enhances Java's type system to make it more powerful and useful. This lets software developers detect and prevent errors in their Java programs. The Checker Framework includes compiler plug-ins ("checkers") that find bugs or verify their absence. It also permits you to write your own compiler plug-ins.

There is a newer version: 3.44.0

Show newest version

package org.checkerframework.checker.calledmethods.qual;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.checkerframework.framework.qual.SubtypeOf;

/**
 * This annotation represents a predicate on {@code @}{@link CalledMethods} annotations. If method
 * {@code c()}'s receiver type is annotated with {@code @CalledMethodsPredicate("a || b")}, then it
 * is acceptable to call either method {@code a()} or method {@code b()} before calling method
 * {@code c()}.
 *
 * @checker_framework.manual #called-methods-checker Called Methods Checker
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE_USE, ElementType.TYPE_PARAMETER})
@SubtypeOf({CalledMethods.class})
public @interface CalledMethodsPredicate {
  /**
   * A boolean expression constructed from the following grammar:
   *
   * S → method name | S && S | S || S | !S | (S)
   *
   * The expression uses standard Java operator precedence: "!" then "&&" then "||".
   *
   * @return the boolean expression
   */
  String value();
}