public static enum API.Status extends Enum<API.Status>
API
annotation must declare its status as
exactly one of these to indicate the stability of that API. The statuses shall be arranged in increasing order of
stability, so that a status shall be "less stable" than a status appearing after it in the enumeration.Enum Constant and Description |
---|
DEPRECATED
Deprecated code that should not be used in new code.
|
EXPERIMENTAL
Used for new features under development where the API has not yet stabilized.
|
INTERNAL
Should not to be used by external code.
|
MAINTAINED
Used for APIs that shall not be changed or removed in the next minor release.
|
STABLE
Used for APIs that shall not be changed in a backwards-incompatible way or removed until the next major release.
|
UNSTABLE
Used by APIs that may change in the next minor release without prior notice.
|
Modifier and Type | Method and Description |
---|---|
static API.Status |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static API.Status[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final API.Status INTERNAL
public
only because it is needed by another
package within the Record Layer core. May change at any time, without prior notice, and without a change
in version. Shall not become less stable since this is the least stable status.public static final API.Status DEPRECATED
public static final API.Status EXPERIMENTAL
public static final API.Status UNSTABLE
EXPERIMENTAL
, this API shall not be changed or be removed until the next minor release. In contrast
to MAINTAINED
code, there may not be advance notification (such as deprecation) before the API is
changed or removed. May become less stable in the next minor release.public static final API.Status MAINTAINED
UNSTABLE
or DEPRECATED
) in the next minor release. This status
change serves as a notification of the potential upcoming change.public static final API.Status STABLE
public static API.Status[] values()
for (API.Status c : API.Status.values()) System.out.println(c);
public static API.Status valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null