Annotation Type DeprecationInfo
-
@Documented @Retention(SOURCE) @Target({CONSTRUCTOR,FIELD,LOCAL_VARIABLE,METHOD,PACKAGE,PARAMETER,TYPE}) public @interface DeprecationInfoProvides additional deprecation information, which should be used alongsideDeprecated.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.StringNO_REPLACEMENTConstant value forDeprecationInfo#replacedBy.
-
Required Element Summary
Required Elements Modifier and Type Required Element Description java.lang.StringeolThe scheduled product version that will see this functionality removed from the codebase.java.lang.StringreasonA short explanation of the deprecation.java.lang.StringsinceThe product version that the deprecation was introduced.
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description java.lang.StringlinkAn optional link to the Github issue, PR or document that covers this deprecation.java.lang.StringreplaceWithShort explanation on what functionality is replacing this deprecation.
-
-
-
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."
-
-
-
replaceWith
java.lang.String replaceWith
Short explanation on what functionality is replacing this deprecation. If there is no replacement,NO_REPLACEMENTshould be used.If a short explanation is insufficient, use
link()to provide additional context.Example: "
MyClass#theMethodReturningDuration()"- Default:
- "noReplacement"
-
-