org.jboss.gravia.runtime

Enum Module.State

java.lang.Object

java.lang.Enum<Module.State>

org.jboss.gravia.runtime.Module.State

All Implemented Interfaces:

Serializable, Comparable<Module.State>

Enclosing interface:

Module

public static enum Module.State
extends Enum<Module.State>

A module can be in one of five states:

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVE The module is now running.
INSTALLED A module is in the INSTALLED state when it has been installed in the Runtime
STARTING The module is in the process of starting.
STOPPING The module is in the process of stopping.
UNINSTALLED The module is uninstalled and may not be used.

Method Summary

Methods

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

INSTALLED

public static final Module.State INSTALLED

A module is in the INSTALLED state when it has been installed in the Runtime

STARTING

public static final Module.State STARTING

The module is in the process of starting.

A module is in the STARTING state when its start method is active. A module must be in this state when the module's ModuleActivator.start(ModuleContext) is called. If the ModuleActivator.start(ModuleContext) method completes without exception, then the module has successfully started and must move to the ACTIVE state.

ACTIVE

public static final Module.State ACTIVE

The module is now running.

A module is in the ACTIVE state when it has been successfully started and activated.

STOPPING

public static final Module.State STOPPING

The module is in the process of stopping.

A module is in the STOPPING state when its stop method is active. A module must be in this state when the module's ModuleActivator.stop(ModuleContext) method is called. When the ModuleActivator.stop method completes the module is stopped and must move to the RESOLVED state.

UNINSTALLED

public static final Module.State UNINSTALLED

The module is uninstalled and may not be used.

Method Detail

values

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

Returns:

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

valueOf

public static Module.State 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