JBoss Modular Service Kernel API 1.0.0.CR2

org.jboss.msc.service
Enum ServiceController.Mode

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

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

The controller mode for a service.


Enum Constant Summary
ACTIVE
          Demand to start, recursively demanding dependencies.
LAZY
          Only come up if all dependencies are satisfied and at least one dependent demands to start.
NEVER
          Do not start; in addition, ignore demands from dependents.
ON_DEMAND
          Only come up if all dependencies are satisfied and at least one dependent demands to start.
PASSIVE
          Come up automatically as soon as all dependencies are satisfied.
REMOVE
          Remove this service and all of its dependents.
 
Method Summary
static ServiceController.Mode valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ServiceController.Mode[] 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

REMOVE

public static final ServiceController.Mode REMOVE
Remove this service and all of its dependents.


NEVER

public static final ServiceController.Mode NEVER
Do not start; in addition, ignore demands from dependents.


ON_DEMAND

public static final ServiceController.Mode ON_DEMAND
Only come up if all dependencies are satisfied and at least one dependent demands to start.


LAZY

public static final ServiceController.Mode LAZY
Only come up if all dependencies are satisfied and at least one dependent demands to start. Once in the UP state, it will remain that way regardless of demands from dependents.


PASSIVE

public static final ServiceController.Mode PASSIVE
Come up automatically as soon as all dependencies are satisfied.


ACTIVE

public static final ServiceController.Mode ACTIVE
Demand to start, recursively demanding dependencies. This is the default mode.

Method Detail

values

public static ServiceController.Mode[] 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.Mode c : ServiceController.Mode.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.Mode 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

JBoss Modular Service Kernel API 1.0.0.CR2

Copyright © 2011 JBoss, a division of Red Hat, Inc.