com.apple.foundationdb.annotation

Enum API.Status

java.lang.Object

java.lang.Enum<API.Status>

com.apple.foundationdb.annotation.API.Status

All Implemented Interfaces:

Serializable, Comparable<API.Status>

Enclosing class:

API

public static enum API.Status
extends Enum<API.Status>

An enum of possible API stability statuses. Each use of the 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 Summary

Enum Constants

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.

Method Summary

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.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INTERNAL

public static final API.Status INTERNAL

Should not to be used by external code. This API is 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.

DEPRECATED

public static final API.Status DEPRECATED

Deprecated code that should not be used in new code. Existing users should transition away from this API. May be removed in the next minor release but must not be removed until the next minor release. May become less stable in the next minor release.

EXPERIMENTAL

public static final API.Status EXPERIMENTAL

Used for new features under development where the API has not yet stabilized. May be used by external consumers with caution, since it may change or be removed without notice or a change in version. May become less stable in the next minor release.

UNSTABLE

public static final API.Status UNSTABLE

Used by APIs that may change in the next minor release without prior notice. In contrast to those marked 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.

MAINTAINED

public static final API.Status MAINTAINED

Used for APIs that shall not be changed or removed in the next minor release. May become less stable in the next minor release. Generally, if this API is to be changed or removed, the status changes first to a lower stability (such as UNSTABLE or DEPRECATED) in the next minor release. This status change serves as a notification of the potential upcoming change.

STABLE

public static final API.Status STABLE

Used for APIs that shall not be changed in a backwards-incompatible way or removed until the next major release. May become less stable in the next major release.

Method Detail

values

public static API.Status[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (API.Status c : API.Status.values())
    System.out.println(c);

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