Enum TaskReturnState
- java.lang.Object
-
- java.lang.Enum<TaskReturnState>
-
- com.unboundid.directory.sdk.ds.types.TaskReturnState
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<TaskReturnState>
@ThreadSafety(level=COMPLETELY_THREADSAFE) public enum TaskReturnState extends java.lang.Enum<TaskReturnState>
This enum defines the states that a task may have after it has completed processing.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description COMPLETED_SUCCESSFULLY
Indicates that the task completed all of its processing without any errors.COMPLETED_WITH_ERRORS
Indicates that the task completed all of its processing but encountered one or more errors in the process.STOPPED_BY_ADMINISTRATOR
Indicates that the task was stopped prematurely because it was canceled by an administrator.STOPPED_BY_ERROR
Indicates that the task was stopped prematurely because an error occurred during processing that made it unable to continue.STOPPED_BY_SHUTDOWN
Indicates that the task was stopped prematurely because the server was shutting down.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static TaskReturnState
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static TaskReturnState[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
COMPLETED_SUCCESSFULLY
public static final TaskReturnState COMPLETED_SUCCESSFULLY
Indicates that the task completed all of its processing without any errors.
-
COMPLETED_WITH_ERRORS
public static final TaskReturnState COMPLETED_WITH_ERRORS
Indicates that the task completed all of its processing but encountered one or more errors in the process.
-
STOPPED_BY_SHUTDOWN
public static final TaskReturnState STOPPED_BY_SHUTDOWN
Indicates that the task was stopped prematurely because the server was shutting down.
-
STOPPED_BY_ERROR
public static final TaskReturnState STOPPED_BY_ERROR
Indicates that the task was stopped prematurely because an error occurred during processing that made it unable to continue.
-
STOPPED_BY_ADMINISTRATOR
public static final TaskReturnState STOPPED_BY_ADMINISTRATOR
Indicates that the task was stopped prematurely because it was canceled by an administrator.
-
-
Method Detail
-
values
public static TaskReturnState[] 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 (TaskReturnState c : TaskReturnState.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static TaskReturnState 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
-
-