com.inductiveautomation.ignition.gateway.tasks

Enum TaskState

java.lang.Object

java.lang.Enum<TaskState>

com.inductiveautomation.ignition.gateway.tasks.TaskState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TaskState>

public enum TaskState
extends java.lang.Enum<TaskState>

Created by colby.clegg on 5/6/2015.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Cancelled
Completed
Errored
Running
Scheduled
Stopped
Suspended
Waiting

Method Summary

Modifier and Type	Method and Description
boolean	isCurrent()
boolean	isTerminal()
static TaskState	valueOf(java.lang.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.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Scheduled

public static final TaskState Scheduled

Running

public static final TaskState Running

Stopped

public static final TaskState Stopped

Suspended

public static final TaskState Suspended

Waiting

public static final TaskState Waiting

Cancelled

public static final TaskState Cancelled

Completed

public static final TaskState Completed

Errored

public static final TaskState Errored

Method Detail

values

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

Returns:

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

valueOf

public static TaskState 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 name

java.lang.NullPointerException - if the argument is null

isTerminal

public boolean isTerminal()

isCurrent

public boolean isCurrent()