com.sun.jbi

Enum ComponentState

java.lang.Object

java.lang.Enum<ComponentState>

com.sun.jbi.ComponentState

All Implemented Interfaces:

Serializable, Comparable<ComponentState>

public enum ComponentState
extends Enum<ComponentState>

ComponentState Enumeration

Author:

Sun Microsystems, Inc.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOADED Loaded status.
SHUTDOWN
STARTED
STOPPED
UNKNOWN

Method Summary

Methods

Modifier and Type	Method and Description
static ComponentState	computeEffectiveState(List<ComponentState> states) Compute the effective state of the Component from a list of Component States If one or more state is a STARTED state the state is STARTED If one or more state is STOPPED state and there is no STARTED state the state is STOPPED If there are no STOPPED or STARTED states the state is SHUTDOWN
static String	getLifeCycleState(ComponentState state) Given the ComponentState convert it to a LifeCycleMBean state string.
static void	main(String[] args)
String	toString()
static ComponentState	valueOf(String name) Returns the enum constant of this type with the specified name.
static ComponentState	valueOfLifeCycleState(String state) Given the LifeCycleMBean state string convert it to a ComponentState.
static ComponentState	valueOfString(String valStr)
static ComponentState[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LOADED

public static final ComponentState LOADED

Loaded status. Note: This never appears in the permanent registry, only in the runtime registry. It is a transient state used only during installation of a component.

SHUTDOWN

public static final ComponentState SHUTDOWN

STOPPED

public static final ComponentState STOPPED

STARTED

public static final ComponentState STARTED

UNKNOWN

public static final ComponentState UNKNOWN

Method Detail

values

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

Returns:

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

valueOf

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

computeEffectiveState

public static ComponentState computeEffectiveState(List<ComponentState> states)

Compute the effective state of the Component from a list of Component States If one or more state is a STARTED state the state is STARTED If one or more state is STOPPED state and there is no STARTED state the state is STOPPED If there are no STOPPED or STARTED states the state is SHUTDOWN

Parameters:

states - - a List of states.

Returns:

the effective component state

valueOfLifeCycleState

public static ComponentState valueOfLifeCycleState(String state)

Given the LifeCycleMBean state string convert it to a ComponentState. This method will be deleted after (a) state strings are fixed "Shutdown" and not "SHUTDOWN" (b) LifeCycleMBean.RUNNING is changed to LifeCycleMBean.STARTED

getLifeCycleState

public static String getLifeCycleState(ComponentState state)

Given the ComponentState convert it to a LifeCycleMBean state string. This method will be deleted after (a) state strings are fixed "Shutdown" and not "SHUTDOWN" (b) LifeCycleMBean.RUNNING is changed to LifeCycleMBean.STARTED

toString

public String toString()

Overrides:

toString in class Enum<ComponentState>

Returns:

the String value for the ComponentType

valueOfString

public static ComponentState valueOfString(String valStr)

Parameters:

valStr - - the string whose equivalent ComponentState instance is required. This operation ignores the case, i.e. Stopped or STOPPED or sToPped would return ComponentState.STOPPED

Returns:

a ComponentState based on the String value.

main

public static void main(String[] args)