Package org.jboss.msc.service

Enum Class ServiceController.State

java.lang.Object

java.lang.Enum<ServiceController.State>

org.jboss.msc.service.ServiceController.State

All Implemented Interfaces:

Serializable, Comparable<ServiceController.State>, Constable

Enclosing interface:

ServiceController<S>

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

A possible state for a service controller.

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
DOWN	Down.
REMOVED	Service was removed from the container.
START_FAILED	Start failed, or was cancelled.
STARTING	Service is starting.
STOPPING	Service is stopping.
UP	Up.

Method Summary

Modifier and Type	Method	Description
boolean	in(ServiceController.State... states)	Determine if this state is one of the given states.
static ServiceController.State	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ServiceController.State[]	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

DOWN

public static final ServiceController.State DOWN

Down. All dependents are down.

STARTING

public static final ServiceController.State STARTING

Service is starting. Dependencies may not enter the DOWN state. This state may not be left until the start method has finished or failed.

START_FAILED

public static final ServiceController.State START_FAILED

Start failed, or was cancelled. From this state, the start may be retried or the service may enter the DOWN state.

UP

public static final ServiceController.State UP

Up.

STOPPING

public static final ServiceController.State STOPPING

Service is stopping. Dependents may not enter the STARTING state. This state may not be left until all dependents are DOWN and the stop method has finished.

REMOVED

public static final ServiceController.State REMOVED

Service was removed from the container.

Method Details

values

public static ServiceController.State[] 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 ServiceController.State 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

in

public boolean in(ServiceController.State... states)

Determine if this state is one of the given states.

Parameters:

states - the states to check

Returns:

true if this state is in the set; false otherwise