Annotation Type DeprecationInfo


  • @Documented
    @Retention(SOURCE)
    @Target({CONSTRUCTOR,FIELD,LOCAL_VARIABLE,METHOD,PACKAGE,PARAMETER,TYPE})
    public @interface DeprecationInfo
    Provides additional deprecation information, which should be used alongside Deprecated.

    For guidance and process of deprecations, please refer to spinnaker.io's "Managing Deprecations" page: https://spinnaker.io/community/contributing/managing-deprecations/

    • Field Summary

      Fields 
      Modifier and Type Fields Description
      static java.lang.String NO_REPLACEMENT
      Constant value for DeprecationInfo#replacedBy.
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String eol
      The scheduled product version that will see this functionality removed from the codebase.
      java.lang.String reason
      A short explanation of the deprecation.
      java.lang.String since
      The product version that the deprecation was introduced.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String link
      An optional link to the Github issue, PR or document that covers this deprecation.
      java.lang.String replaceWith
      Short explanation on what functionality is replacing this deprecation.
    • Field Detail

      • NO_REPLACEMENT

        static final java.lang.String NO_REPLACEMENT
        Constant value for DeprecationInfo#replacedBy.
    • Element Detail

      • reason

        java.lang.String reason
        A short explanation of the deprecation.

        If a short explanation is insufficient, use link() to provide additional context.

        Example: "Use of Duration is preferred over primitive long values."

      • since

        java.lang.String since
        The product version that the deprecation was introduced.

        Example: "1.20.0"

      • eol

        java.lang.String eol
        The scheduled product version that will see this functionality removed from the codebase.

        Example: "1.25.0"

      • replaceWith

        java.lang.String replaceWith
        Short explanation on what functionality is replacing this deprecation. If there is no replacement, NO_REPLACEMENT should be used.

        If a short explanation is insufficient, use link() to provide additional context.

        Example: "MyClass#theMethodReturningDuration()"

        Default:
        "noReplacement"
      • link

        java.lang.String link
        An optional link to the Github issue, PR or document that covers this deprecation.
        Default:
        ""