Annotation Type ApiStatus.ScheduledForRemoval


  • @Documented
    @Retention(CLASS)
    @Target({TYPE,ANNOTATION_TYPE,METHOD,CONSTRUCTOR,FIELD,PACKAGE})
    public static @interface ApiStatus.ScheduledForRemoval

    Indicates that a public API of the annotated element (class, method or field) is subject to removal in a future version. It's a stronger variant of Deprecated annotation.

    Since many tools aren't aware of this annotation it should be used as an addition to @Deprecated annotation or @deprecated Javadoc tag only.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String inVersion
      Specifies in which version the API will be removed.
    • Element Detail

      • inVersion

        java.lang.String inVersion
        Specifies in which version the API will be removed.
        Default:
        ""