Package org.praxislive.ide.core.api

Enum Class Task.State

java.lang.Object

java.lang.Enum<Task.State>

org.praxislive.ide.core.api.Task.State

All Implemented Interfaces:

Serializable, Comparable<Task.State>, Constable

Enclosing interface:

Task

public static enum Task.State
extends Enum<Task.State>

The possible states of a Task.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANCELLED	The state of a task that has been cancelled by the user.
COMPLETED	The state of a completed task.
ERROR	The state of a task that was unable to complete due to error.
NEW	The starting state of all tasks before execution has been started.
RUNNING	The state of a task being executed, either inside the Task.execute() method or during subsequent asynchronous operations.

Method Summary

Modifier and Type	Method	Description
static Task.State	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Task.State[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NEW

public static final Task.State NEW

The starting state of all tasks before execution has been started.

RUNNING

public static final Task.State RUNNING

The state of a task being executed, either inside the Task.execute() method or during subsequent asynchronous operations.

CANCELLED

public static final Task.State CANCELLED

The state of a task that has been cancelled by the user.

COMPLETED

public static final Task.State COMPLETED

The state of a completed task.

ERROR

public static final Task.State ERROR

The state of a task that was unable to complete due to error.

Method Details

values

public static Task.State[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Task.State valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null