org.checkerframework.checker.calledmethods.qual.EnsuresCalledMethodsVarArgs 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.Target;

/**
 * Indicates that the method, if it terminates successfully, always invokes the given methods on all
 * of the arguments passed in the varargs position.
 *
 * Consider the following method:
 *
 * 
 * @EnsuresCalledMethodsVarArgs("m")
 * public void callMOnAll(S s, T t...) { ... }
 * 
 *
 * This method guarantees that {@code m()} is always called on every {@code T} object passed in
 * the {@code t} varargs argument before the method returns.
 *
 * This annotation is not checked. An error will always be issued when it is used.
 */
@Target({ElementType.METHOD, ElementType.CONSTRUCTOR})
public @interface EnsuresCalledMethodsVarArgs {

  /**
   * Returns the methods guaranteed to be invoked on the varargs parameters.
   *
   * @return the methods guaranteed to be invoked on the varargs parameters
   */
  String[] value();
}