Package org.forgerock.api.enums

Enum Class CreateSingleton

java.lang.Object

java.lang.Enum<CreateSingleton>

org.forgerock.api.enums.CreateSingleton

All Implemented Interfaces:

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

public enum CreateSingleton
extends Enum<CreateSingleton>

Types of create that might be singletons.

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
FALSE	The created resource is not a singleton.
FROM_CONTEXT	Derive the singleton from the usage context.
TRUE	The created resource is a singleton.

Method Summary

Modifier and Type	Method	Description
static CreateSingleton	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CreateSingleton[]	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

TRUE

public static final CreateSingleton TRUE

The created resource is a singleton.

FALSE

public static final CreateSingleton FALSE

The created resource is not a singleton.

FROM_CONTEXT

public static final CreateSingleton FROM_CONTEXT

Derive the singleton from the usage context.

Method Details

values

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