Package org.jetbrains.annotations
Annotation Interface NotNull
@Documented
@Retention(CLASS)
@Target({METHOD,FIELD,PARAMETER,LOCAL_VARIABLE,TYPE_USE})
public @interface NotNull
An element annotated with NotNull claims
null
value is forbidden
to return (for methods), pass to (parameters) and hold (local variables and fields).
Apart from documentation purposes this annotation is intended to be used by static analysis tools
to validate against probable runtime errors and element contract violations.-
Optional Element Summary
Optional Elements
-
Element Details
-
value
String value- Returns:
- Custom exception message
- Default:
- ""
-
exception
- Returns:
- Custom exception type that should be thrown when not-nullity contract is violated.
The exception class should have a constructor with one String argument (message).
By default,
IllegalArgumentException
is thrown on null method arguments andIllegalStateException
— on null return value.
- Default:
- java.lang.Exception.class
-