Package org.apiguardian.api
Enum Class API.Status
- All Implemented Interfaces:
Serializable
,Comparable<API.Status>
,Constable
- Enclosing class:
- API
Indicates the status of an API element and therefore its level of
stability as well.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionShould no longer be used.Intended for new, experimental features where the publisher of the API is looking for feedback.Must not be used by any external code.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.Intended for features that will not be changed in a backwards-incompatible way in the current major version. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic API.Status
Returns the enum constant of this class with the specified name.static API.Status[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
INTERNAL
Must not be used by any external code. Might be removed without prior notice. -
DEPRECATED
Should no longer be used. Might disappear in the next minor release.This status is usually used in combination with the standard annotation
@Deprecated
because that annotation is recognized by IDEs and the compiler. However, there are also cases where this status can be used on its own, for example when transitioning aMAINTAINED
feature to anINTERNAL
one. -
EXPERIMENTAL
Intended for new, experimental features where the publisher of the API is looking for feedback.Use with caution. Might be promoted to
MAINTAINED
orSTABLE
in the future, but might also be removed without prior notice. -
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 toDEPRECATED
first. -
STABLE
Intended for features that will not be changed in a backwards-incompatible way in the current major version.
-
-
Constructor Details
-
Status
private Status()
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-