org.forgerock.api.enums

Enum CreateSingleton

java.lang.Object

java.lang.Enum<CreateSingleton>

org.forgerock.api.enums.CreateSingleton

All Implemented Interfaces:

Serializable, Comparable<CreateSingleton>

public enum CreateSingleton
extends Enum<CreateSingleton>

Types of create that might be singletons.

Enum Constant Summary

Enum Constants

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

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 Detail

values

public static CreateSingleton[] 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 (CreateSingleton c : CreateSingleton.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

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