Enum FailedDependencyAction
- java.lang.Object
-
- java.lang.Enum<FailedDependencyAction>
-
- 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>
This class defines a failed dependency action, which controls how a task should behave if any of its dependencies fails.
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description 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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.
-
-
-
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 namejava.lang.NullPointerException
- if the argument is null
-
getName
@NotNull public java.lang.String getName()
Retrieves the name of this failed dependency action.- Returns:
- The name of this failed dependency action.
-
forName
@Nullable public static FailedDependencyAction forName(@NotNull java.lang.String name)
Retrieves the failed dependency action with the specified name.- Parameters:
name
- The name of the failed dependency action to retrieve. It must not benull
.- Returns:
- The requested failed dependency action, or
null
if there is no action with the given name.
-
toString
@NotNull public java.lang.String toString()
Retrieves a string representation of this failed dependency action.- Overrides:
toString
in classjava.lang.Enum<FailedDependencyAction>
- Returns:
- A string representation of this failed dependency action.
-
-