Package io.micronaut.core.annotation

Annotation Interface Nullable

@Target({METHOD,PARAMETER,FIELD,ANNOTATION_TYPE,TYPE_PARAMETER,TYPE_USE}) @Retention(RUNTIME) @Documented @Nullable public @interface Nullable
A common annotation to declare that annotated elements can be null under some circumstance. Leverages JSR 305 meta-annotations to indicate nullability in Java to common tools with JSR 305 support and used by Kotlin to infer nullability of Micronaut API.

Should be used at parameter, return value, and field level. Methods override should repeat parent @Nullable annotations unless they behave differently.

Since:
2.4
Author:
graemerocher
See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    inherited
    Whether the nullable behaviour is inherited by subclasses or implementors in interfaces.

  • Element Details

    • inherited

      boolean inherited
      Whether the nullable behaviour is inherited by subclasses or implementors in interfaces.
      Returns:
      True if it should be inherited (defaults to false)
      Since:
      4.1.0
      Default:
      false