com.unboundid.ldap.sdk.unboundidds.tasks
Enum FailedDependencyAction

java.lang.Object
  extended by java.lang.Enum<FailedDependencyAction>
      extended by com.unboundid.ldap.sdk.unboundidds.tasks.FailedDependencyAction
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<FailedDependencyAction>

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public enum FailedDependencyAction
extends java.lang.Enum<FailedDependencyAction>

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This class defines a failed dependency action, which controls how a task should behave if any of its dependencies fails.


Enum Constant Summary
CANCEL
          The failed dependency action that indicates the dependent task should be canceled if any of its dependencies had failed.
DISABLE
          The failed dependency action that indicates the dependent task should be disabled if any of its dependencies had failed.
PROCESS
          The failed dependency action that indicates the dependent task should go ahead and continue processing as if none of its dependencies had failed.
 
Method Summary
static FailedDependencyAction forName(java.lang.String name)
          Retrieves the failed dependency action with the specified name.
 java.lang.String getName()
          Retrieves the name of this failed dependency action.
 java.lang.String toString()
          Retrieves a string representation of this failed dependency 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, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

PROCESS

public static final FailedDependencyAction PROCESS
The failed dependency action that indicates the dependent task should go ahead and continue processing as if none of its dependencies had failed.


CANCEL

public static final FailedDependencyAction CANCEL
The failed dependency action that indicates the dependent task should be canceled if any of its dependencies had failed.


DISABLE

public static final FailedDependencyAction DISABLE
The failed dependency action that indicates the dependent task should be disabled if any of its dependencies had failed.

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

getName

public java.lang.String getName()
Retrieves the name of this failed dependency action.

Returns:
The name of this failed dependency action.

forName

public static FailedDependencyAction forName(java.lang.String name)
Retrieves the failed dependency action with the specified name.

Parameters:
name - The name of the failed dependency action to retrieve.
Returns:
The requested failed dependency action, or null if there is no action with the given name.

toString

public java.lang.String toString()
Retrieves a string representation of this failed dependency action.

Overrides:
toString in class java.lang.Enum<FailedDependencyAction>
Returns:
A string representation of this failed dependency action.