Module pl.tlinkowski.annotation.basic

Package pl.tlinkowski.annotation.basic

Annotation Type NonNullPackage

@Documented
@Nonnull
@Retention(RUNTIME)
@Target(PACKAGE)
@TypeQualifierDefault({TYPE_USE,TYPE_PARAMETER})
public @interface NonNullPackage

Declares that all type uses (e.g. fields, method return types, method parameters, type parameters, local variables) within an annotated package are non-null by default.

Should be used at package level in association with NullOr annotations at type use level.

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

Analogous to (except for the scope of affected entities): NonNullApi in Spring, ParametersAreNonnullByDefault in JSR 305.

Author:

Tomasz Linkowski