Package org.forgerock.api.enums

Enum Class Stability

java.lang.Object

java.lang.Enum<Stability>

org.forgerock.api.enums.Stability

All Implemented Interfaces:

Serializable, Comparable<Stability>, java.lang.constant.Constable

public enum Stability
extends Enum<Stability>

Represents API stability.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEPRECATED	Deprecated API, that should not be used and may be removed in the future.
EVOLVING	Evolving API that may changed at any time.
INTERNAL	Internal API that may change or be removed at any time.
REMOVED	Removed API, that remains available for some technical reason and may return an error if used.
STABLE	Stable API (default), suggested for use by all clients.

Method Summary

Modifier and Type	Method	Description
static Stability	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Stability[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

STABLE

public static final Stability STABLE

Stable API (default), suggested for use by all clients.

INTERNAL

public static final Stability INTERNAL

Internal API that may change or be removed at any time.

EVOLVING

public static final Stability EVOLVING

Evolving API that may changed at any time.

DEPRECATED

public static final Stability DEPRECATED

Deprecated API, that should not be used and may be removed in the future.

REMOVED

public static final Stability REMOVED

Removed API, that remains available for some technical reason and may return an error if used.

Method Details

values

public static Stability[] 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

public static Stability valueOf(String name)

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 name

NullPointerException - if the argument is null