org.jboss.msc.service
Enum ServiceController.Substate

java.lang.Object
  extended by java.lang.Enum<ServiceController.Substate>
      extended by org.jboss.msc.service.ServiceController.Substate
All Implemented Interfaces:
Serializable, Comparable<ServiceController.Substate>
Enclosing interface:
ServiceController<S>

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

A fine-grained substate of the more general basic controller ServiceController.States. The list of possible substates may change over time, so users should not rely on its permanence.


Enum Constant Summary
CANCELLED
          Cancelled controller installation due to duplicate or other problem.
DOWN
          Controller is down.
NEW
          New controller being installed.
PROBLEM
          Controller cannot start due to a problem with a dependency or transitive dependency.
REMOVED
          Service has been removed.
REMOVING
          Service is being removed.
START_FAILED
          Start failed.
START_INITIATING
          First phase of start processing.
START_REQUESTED
          A stopped controller has been requested to start.
STARTING
          Second phase of start processing (start() method invoked).
STOP_REQUESTED
          Service is up but has been requested to stop.
STOPPING
          Service is stopping.
UP
          Service is up.
WAITING
          Controller is waiting for an external condition to start, such as a dependent demand.
WONT_START
          Controller is configured not to start.
 
Method Summary
 ServiceController.State getState()
          Get the state corresponding to this sub-state.
 boolean isRestState()
          Determine whether this is a "rest" state.
static ServiceController.Substate valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ServiceController.Substate[] 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

NEW

public static final ServiceController.Substate NEW
New controller being installed.


CANCELLED

public static final ServiceController.Substate CANCELLED
Cancelled controller installation due to duplicate or other problem.


DOWN

public static final ServiceController.Substate DOWN
Controller is down.


WAITING

public static final ServiceController.Substate WAITING
Controller is waiting for an external condition to start, such as a dependent demand.


WONT_START

public static final ServiceController.Substate WONT_START
Controller is configured not to start.


PROBLEM

public static final ServiceController.Substate PROBLEM
Controller cannot start due to a problem with a dependency or transitive dependency.


START_REQUESTED

public static final ServiceController.Substate START_REQUESTED
A stopped controller has been requested to start.


START_INITIATING

public static final ServiceController.Substate START_INITIATING
First phase of start processing.


STARTING

public static final ServiceController.Substate STARTING
Second phase of start processing (start() method invoked).


START_FAILED

public static final ServiceController.Substate START_FAILED
Start failed.


UP

public static final ServiceController.Substate UP
Service is up.


STOP_REQUESTED

public static final ServiceController.Substate STOP_REQUESTED
Service is up but has been requested to stop.


STOPPING

public static final ServiceController.Substate STOPPING
Service is stopping.


REMOVING

public static final ServiceController.Substate REMOVING
Service is being removed.


REMOVED

public static final ServiceController.Substate REMOVED
Service has been removed.

Method Detail

values

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

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

valueOf

public static ServiceController.Substate 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

isRestState

public boolean isRestState()
Determine whether this is a "rest" state.

Returns:
true if it is a rest state, false otherwise

getState

public ServiceController.State getState()
Get the state corresponding to this sub-state.

Returns:
the state


Copyright © 2011. All Rights Reserved.