org.opends.server.backends.task
Enum FailedDependencyAction

java.lang.Object
  extended by java.lang.Enum<FailedDependencyAction>
      extended by org.opends.server.backends.task.FailedDependencyAction
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<FailedDependencyAction>

public enum FailedDependencyAction
extends java.lang.Enum<FailedDependencyAction>

This enumeration defines the various ways that a task can behave if it is dependent upon another task and that earlier task is done running but did not complete successfully.


Enum Constant Summary
CANCEL
          The action that indicates that the dependent task should be canceled.
DISABLE
          The action that indicates that the dependent task should be disabled so that an administrator will have to re-enable it before it can start.
PROCESS
          The action that indicates that the dependent task should be processed anyway.
 
Method Summary
static FailedDependencyAction defaultValue()
          Returns the default action.
static FailedDependencyAction fromString(java.lang.String s)
          Retrieves the failed dependency action that corresponds to the provided string value.
 Message getDisplayName()
          Gets the display name of this action.
static FailedDependencyAction valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static FailedDependencyAction[] 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

PROCESS

public static final FailedDependencyAction PROCESS
The action that indicates that the dependent task should be processed anyway.


CANCEL

public static final FailedDependencyAction CANCEL
The action that indicates that the dependent task should be canceled.


DISABLE

public static final FailedDependencyAction DISABLE
The action that indicates that the dependent task should be disabled so that an administrator will have to re-enable it before it can start.

Method Detail

values

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

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

valueOf

public static FailedDependencyAction valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

defaultValue

public static FailedDependencyAction defaultValue()
Returns the default action.

Returns:
the default action

fromString

public static FailedDependencyAction fromString(java.lang.String s)
Retrieves the failed dependency action that corresponds to the provided string value.

Parameters:
s - The string value for which to retrieve the corresponding failed dependency action.
Returns:
The corresponding failed dependency action, or null if none could be associated with the provided string.

getDisplayName

public Message getDisplayName()
Gets the display name of this action.

Returns:
Message representing the name of this action