checkers.nullness.quals

Annotation Type AssertNonNullIfFalse

public @interface AssertNonNullIfFalse

Indicates that if the method returns false, then the value expressions are non-null.

For instance, if AbstractCollection.isEmpty() is false, then PriorityQueue.peek() is nonnull. You can express this relationship as:

  @AssertNonNullIfFalse({"peek()"})
   public boolean isEmpty() { ... }
 

Another example is this method:

   // Returns whether the line is blank (or null).
   @AssertNonNullIfFalse("#0")
   private static boolean isBlank(@Nullable String line) {
     return (line == null) || line.trim().equals("");
   }

As a final example, consider this method:

   // Indicates whether the representation has been erased
   @AssertNonNullIfFalse("values")
   public boolean repNulled() {
     return values == null;
   }

See Also:

NonNull, AssertNonNullIfTrue, NullnessChecker

See the Checker Framework manual:

Nullness Checker

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String[]	value Java expression(s) that are non-null after the method returns false.

Element Detail

value

public abstract String[] value

Java expression(s) that are non-null after the method returns false.

See Also:

Syntax of Java expressions