org.checkerframework.checker.nullness.qual

Annotation Type RequiresNonNull

@Documented
 @Retention(value=RUNTIME)
 @Target(value={METHOD,CONSTRUCTOR})
public @interface RequiresNonNull

Indicates a method precondition: the method expects the specified expressions to be non-null when the annotated method is invoked.

For example:

  @Nullable Object field1;
  @Nullable Object field2;

  @RequiresNonNull("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
  }
 

See the Checker Framework Manual:

Nullness Checker

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String[]	value The Java expressions that need to be NonNull.

Element Detail

value

public abstract java.lang.String[] value

The Java expressions that need to be NonNull.

See the Checker Framework Manual:

Syntax of Java expressions