Module pl.tlinkowski.annotation.basic

Package pl.tlinkowski.annotation.basic

Annotation Type NullOr

@Documented
@Nonnull(when=MAYBE)
@Retention(RUNTIME)
@Target({TYPE_USE,TYPE_PARAMETER})
@TypeQualifierNickname
public @interface NullOr

Declares that the annotated type use (e.g. field, method return type, method parameter, type parameter, local variable) can be null.

Should be used at type use level in association with NonNullPackage annotation at package level.

Recognized by IDEs (e.g. IntelliJ) and by Kotlin (to infer nullability for its types).

Analogous to (except for the scope of allowed targets): Nullable in Spring, CheckForNull in JSR 305.

Author:

Tomasz Linkowski