org.ow2.proactive.scheduler.common.task

Enum TaskStatus

java.lang.Object

java.lang.Enum<TaskStatus>

org.ow2.proactive.scheduler.common.task.TaskStatus

All Implemented Interfaces:

Serializable, Comparable<TaskStatus>

@PublicAPI
public enum TaskStatus
extends Enum<TaskStatus>
implements Serializable

This class represents every status that a task is able to be in.
Each status are best describe below.

Since:

ProActive Scheduling 0.9

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABORTED The task has been aborted by an exception on an other task while the task is running.
FAILED The task is failed (only if max execution time has been reached and the node on which it was started is down).
FAULTY The task has finished execution with error code (!=0) or exception.
FINISHED The task has finished execution.
IN_ERROR The task is suspended after first error and is waiting for a manual restart action.
NOT_RESTARTED The task could not be restarted. It means that the task could not be restarted after an error during the previous execution
NOT_STARTED The task could not be started. It means that the task will not be started due to dependence's failure.
PAUSED The task is paused.
PENDING The task is in the scheduler pending queue.
RUNNING The task is executing.
SKIPPED The task was not executed: it was the non-selected branch of an IF/ELSE control flow action
SUBMITTED The task has just been submitted by the user.
WAITING_ON_ERROR The task is waiting for restart after an error.
WAITING_ON_FAILURE The task is waiting for restart after a failure.

Field Summary

Fields

Modifier and Type	Field and Description
static Set<TaskStatus>	ERROR_TASKS
static Set<TaskStatus>	FINISHED_TASKS
static Set<TaskStatus>	PAUSED_AND_IN_ERROR_TASKS
static Set<TaskStatus>	PENDING_TASKS
static Set<TaskStatus>	RUNNING_TASKS

Method Summary

Modifier and Type	Method and Description
static String	aggregatedStatusesToFilterString(List<String> statuses)
static List<TaskStatus>	allExceptThese(TaskStatus... taskStatuses)
static Set<TaskStatus>	expandAggregatedStatusesToRealStatuses(List<String> aggregatedStatuses)
boolean	isTaskAlive()
static String	statusesToString(Set<TaskStatus> actualStatuses)
static String	statusFilterString(Set<TaskStatus> statuses)
static Set<TaskStatus>	taskStatuses(boolean pending, boolean running, boolean finished)
String	toString()
static TaskStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static TaskStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
static List<String>	wrapIntoAggregatedStatuses(Set<TaskStatus> actualStatuses)

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

SUBMITTED

public static final TaskStatus SUBMITTED

The task has just been submitted by the user.

PENDING

public static final TaskStatus PENDING

The task is in the scheduler pending queue.

PAUSED

public static final TaskStatus PAUSED

The task is paused.

RUNNING

public static final TaskStatus RUNNING

The task is executing.

WAITING_ON_ERROR

public static final TaskStatus WAITING_ON_ERROR

The task is waiting for restart after an error. (ie:native code != 0 or exception)

WAITING_ON_FAILURE

public static final TaskStatus WAITING_ON_FAILURE

The task is waiting for restart after a failure. (ie:node down)

FAILED

public static final TaskStatus FAILED

The task is failed (only if max execution time has been reached and the node on which it was started is down).

NOT_STARTED

public static final TaskStatus NOT_STARTED

The task could not be started.
It means that the task will not be started due to dependence's failure.

NOT_RESTARTED

public static final TaskStatus NOT_RESTARTED

The task could not be restarted.
It means that the task could not be restarted after an error during the previous execution

ABORTED

public static final TaskStatus ABORTED

The task has been aborted by an exception on an other task while the task is running. (job is cancelOnError=true) Can be also in this status if the job is killed while the concerned task was running.

FAULTY

public static final TaskStatus FAULTY

The task has finished execution with error code (!=0) or exception.

FINISHED

public static final TaskStatus FINISHED

The task has finished execution.

SKIPPED

public static final TaskStatus SKIPPED

The task was not executed: it was the non-selected branch of an IF/ELSE control flow action

IN_ERROR

public static final TaskStatus IN_ERROR

The task is suspended after first error and is waiting for a manual restart action.

Field Detail

ERROR_TASKS

public static final Set<TaskStatus> ERROR_TASKS

FINISHED_TASKS

public static final Set<TaskStatus> FINISHED_TASKS

RUNNING_TASKS

public static final Set<TaskStatus> RUNNING_TASKS

PAUSED_AND_IN_ERROR_TASKS

public static final Set<TaskStatus> PAUSED_AND_IN_ERROR_TASKS

PENDING_TASKS

public static final Set<TaskStatus> PENDING_TASKS

Method Detail

values

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

Returns:

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

valueOf

public static TaskStatus valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isTaskAlive

public boolean isTaskAlive()

toString

public String toString()

Overrides:

toString in class Enum<TaskStatus>

See Also:

Enum.toString()

allExceptThese

public static List<TaskStatus> allExceptThese(TaskStatus... taskStatuses)

expandAggregatedStatusesToRealStatuses

public static Set<TaskStatus> expandAggregatedStatusesToRealStatuses(List<String> aggregatedStatuses)

wrapIntoAggregatedStatuses

public static List<String> wrapIntoAggregatedStatuses(Set<TaskStatus> actualStatuses)

aggregatedStatusesToFilterString

public static String aggregatedStatusesToFilterString(List<String> statuses)

statusesToString

public static String statusesToString(Set<TaskStatus> actualStatuses)

taskStatuses

public static Set<TaskStatus> taskStatuses(boolean pending,
                                           boolean running,
                                           boolean finished)

statusFilterString

public static String statusFilterString(Set<TaskStatus> statuses)