Enum API.Status

java.lang.Object
java.lang.Enum<API.Status>
aQute.bnd.apiguardian.api.API.Status
All Implemented Interfaces:
Serializable, Comparable<API.Status>, java.lang.constant.Constable
Enclosing class:
API

public static enum API.Status extends Enum<API.Status>
Indicates the status of an API element and therefore its level of stability as well.
  • Enum Constant Details

    • INTERNAL

      public static final API.Status INTERNAL
      Must not be used by any external code. Might be removed without prior notice.
    • DEPRECATED

      public static final API.Status DEPRECATED
      Should no longer be used. Might disappear in the next minor release.
    • EXPERIMENTAL

      public static final API.Status EXPERIMENTAL
      Intended for new, experimental features where the publisher of the API is looking for feedback.

      Use with caution. Might be promoted to MAINTAINED or STABLE in the future, but might also be removed without prior notice.

    • MAINTAINED

      public static final API.Status MAINTAINED
      Intended for features that will not be changed in a backwards-incompatible way for at least the next minor release of the current major version. If scheduled for removal, such a feature will be demoted to DEPRECATED first.
    • STABLE

      public static final API.Status STABLE
      Intended for features that will not be changed in a backwards-incompatible way in the current major version.
  • Method Details

    • values

      public static API.Status[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static API.Status valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null