EnsuresNonNull (checker-framework 2.5.1 API)

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

Indicates that the value expressions are non-null, if the method terminates successfully.

This postcondition annotation is useful for methods that initialize a field:


  @EnsuresNonNull("theMap")
  public static void initialize() {
    theMap = new HashMap<>();
  }

It can also be used for a method that fails if a given expression is null:


  /** Throws an exception if the argument is null. */
  @EnsuresNonNull("#1")
  void assertNonNull(Object arg) { ... }

Required Elements
Modifier and Type	Required Element and Description
`java.lang.String[]`	`value` The Java expressions that are ensured to be `NonNull` on successful method termination.

Annotation Type EnsuresNonNull