checkers.nullness.quals
Annotation Type AssertNonNullIfTrue


@Documented
@Retention(value=RUNTIME)
@Target(value=METHOD)
public @interface AssertNonNullIfTrue

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

For instance, if File.isDirectory() is true, then File.list() is non-null, and File.listFiles() is non-null. You can express this relationship as:

   @AssertNonNullIfTrue({"list()","listFiles()"})
   public boolean isDirectory() { ... }
 

See Also:
NonNull, AssertNonNullIfFalse, NullnessChecker
See the Checker Framework manual:
Nullness Checker

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

Element Detail

value

public abstract String[] value
Java expression(s) that are non-null after the method returns true.

See Also:
Syntax of Java expressions