public enum TaskState extends Enum<TaskState>
Enum Constant and Description |
---|
CANCELED_BEFORE_STARTING
The task state that indicates that the task was canceled by an administrator before it started running.
|
COMPLETED_SUCCESSFULLY
The task state that indicates that the task has completed without any errors.
|
COMPLETED_WITH_ERRORS
The task state that indicates that the task was able to complete its intended goal, but that one or more errors
were encountered during the process.
|
DISABLED
The task state that indicates that the task has been disabled by an administrator.
|
RECURRING
The task state that indicates that the task is recurring.
|
RUNNING
The task state that indicates that the task is currently running.
|
STOPPED_BY_ADMINISTRATOR
The task state that indicates that the task was stopped by an administrator after it had already started but
before it was able to complete.
|
STOPPED_BY_ERROR
The task state that indicates that one or more errors prevented the task from completing.
|
STOPPED_BY_SHUTDOWN
The task state that indicates that the task was unable to complete because it was interrupted by the shutdown of
the task backend.
|
UNSCHEDULED
The task state that indicates that the task has not yet been scheduled, or possibly that the scheduler is
currently not running.
|
WAITING_ON_DEPENDENCY
The task state that indicates that at least one of the task's defined dependencies has not yet completed.
|
WAITING_ON_START_TIME
The task state that indicates that the task's scheduled start time has not yet arrived.
|
Modifier and Type | Method and Description |
---|---|
static TaskState |
fromString(String s)
Retrieves the task state that corresponds to the provided string value.
|
LocalizableMessage |
getDisplayName()
Gets a locale sensitive representation of this state.
|
static boolean |
isCancelled(TaskState taskState)
Indicates whether this task has been cancelled.
|
static boolean |
isDone(TaskState taskState)
Indicates whether a task with the specified state has completed all the processing that it will do, regardless of
whether it completed its intended goal.
|
static boolean |
isPending(TaskState taskState)
Indicates whether a task with the specified state is currently pending execution.
|
static boolean |
isRecurring(TaskState taskState)
Indicates whether a task with the specified state is recurring.
|
static boolean |
isRunning(TaskState taskState)
Indicates whether a task with the specified state is currently running.
|
static boolean |
isSuccessful(TaskState taskState)
Indicates whether a task with the specified state has been able to complete its intended goal.
|
static TaskState |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static TaskState[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final TaskState UNSCHEDULED
public static final TaskState DISABLED
public static final TaskState WAITING_ON_START_TIME
public static final TaskState WAITING_ON_DEPENDENCY
public static final TaskState RUNNING
public static final TaskState RECURRING
public static final TaskState COMPLETED_SUCCESSFULLY
public static final TaskState COMPLETED_WITH_ERRORS
public static final TaskState STOPPED_BY_SHUTDOWN
public static final TaskState STOPPED_BY_ERROR
public static final TaskState STOPPED_BY_ADMINISTRATOR
public static final TaskState CANCELED_BEFORE_STARTING
public static TaskState[] values()
for (TaskState c : TaskState.values()) System.out.println(c);
public static TaskState valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullpublic static boolean isPending(TaskState taskState)
taskState
- The task state for which to make the determination.true
if the task state indicates that the task is currently pending, or false
otherwise.public static boolean isRunning(TaskState taskState)
taskState
- The task state for which to make the determination.true
if the task state indicates that the task is currently running, or false
otherwise.public static boolean isRecurring(TaskState taskState)
taskState
- The task state for which to make the determination.true
if the task state indicates that the task is recurring, or false
otherwise.public static boolean isDone(TaskState taskState)
taskState
- The task state for which to make the determination.false
if the task state indicates that the task has not yet started or is currently running, or
true
otherwisepublic static boolean isSuccessful(TaskState taskState)
taskState
- The task state for which to make the determination.true
if the task state indicates that the task completed successfully or with minor errors that
still allowed it to achieve its goal, or false
otherwise.public static boolean isCancelled(TaskState taskState)
taskState
- The task state for which to make the determination.true
if the task state indicates that the task was cancelled either before or during execution,
or false
otherwise.public static TaskState fromString(String s)
s
- The string value for which to retrieve the corresponding task state.null
if none could be associated with the provided string.public LocalizableMessage getDisplayName()
Copyright 2010-2022 ForgeRock AS.