Annotation Type ObsoleteApi (2.20.0)

public interface ObsoleteApi implements Annotation

Indicates a public API is obsolete, and will be deprecated in a future version.

Usage guidelines:

  1. This annotation must be used only on APIs with non-private visibility.
  2. This annotation should only be added if either an alternative API is provided and/or we plan to stop supporting the API in a future version.
  3. This annotation must be used with a description.
  4. Alternative APIs must be referenced in Javadoc and/or description if possible.

Implements

Annotation

Methods

value()

public abstract String value()

Context information such as links to a discussion thread, tracking issue, etc.

Returns
TypeDescription
String