Package org.forgerock.util.thread.listener

Enum ShutdownPriority

java.lang.Object

java.lang.Enum<ShutdownPriority>

org.forgerock.util.thread.listener.ShutdownPriority

All Implemented Interfaces:

Serializable, Comparable<ShutdownPriority>

public enum ShutdownPriority
extends Enum<ShutdownPriority>

This class defines the shutdown priorities that are consumed by com.sun.identity.common.ShutdownManager.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEFAULT	DEFAULT is the priority pre-defined in the system.
HIGHEST	HIGHEST is the priority pre-defined in the system.
LOWEST	LOWEST is the priority pre-defined in the system.

Method Summary

Modifier and Type	Method	Description
int	getIntValue()	Returns the priority.
static List<ShutdownPriority>	getPriorities()	Returns list of all the priorities (ordered from the highest to the lowest priority) defined in the system.
static ShutdownPriority	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ShutdownPriority[]	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

HIGHEST

public static final ShutdownPriority HIGHEST

HIGHEST is the priority pre-defined in the system. Components which are registered with this priority will be shutdown first.

DEFAULT

public static final ShutdownPriority DEFAULT

DEFAULT is the priority pre-defined in the system. Components which are registered with this priority will be shutdown after the componets with HIGHEST priority.

LOWEST

public static final ShutdownPriority LOWEST

LOWEST is the priority pre-defined in the system. Components which are registered with this priority will be shutdown after the componets with HIGHEST or DEFAULT priority.

Method Detail

values

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

Returns:

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

valueOf

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

getIntValue

public int getIntValue()

Returns the priority.

Returns:

the priority.

getPriorities

public static List<ShutdownPriority> getPriorities()

Returns list of all the priorities (ordered from the highest to the lowest priority) defined in the system.

Returns:

list of all the priorities defined in the system.