NonNullOnEntry.java

package checkers.nullness.quals;

import java.lang.annotation.*;

/**
 * Indicates a method postcondition:  the method expects the specified
 * variables (typically field references) to be non-null when the annotated
 * method is invoked.
 *
 * <p>For example:
 * <!-- The " " is to hide the at-signs from Javadoc. -->
 * <pre>
 *  @Nullable Object field1;
 *  @Nullable Object field2;
 *
 *  @NonNullOnEntry("field1")
 *  void method1() {
 *    field1.toString();        // OK, field1 is known to be non-null
 *    field2.toString();        // error, might throw NullPointerException
 *  }
 *
 *  void method2() {
 *    field1 = new Object();
 *    method1();                // OK, satisfies method precondition
 *    field1 = null;
 *    method1();                // error, does not satisfy method precondition
 *  }
 * </pre>
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
//@Target({ElementType.METHOD, ElementType.CONSTRUCTOR})
public @interface NonNullOnEntry {
    String[] value();
}