TaskState

java.lang.Object

java.lang.Enum<TaskState>

com.inductiveautomation.ignition.gateway.tasks.TaskState

All Implemented Interfaces:: Serializable, Comparable<TaskState>, Constable

public enum TaskState extends Enum<TaskState>

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

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

Completed

Errored

Running

Scheduled

Stopped

Suspended

Unknown

Waiting
Method Summary

Modifier and Type

Method

Description

boolean

isCurrent()

boolean

isTerminal()

static TaskState

valueOf(String name)

Returns the enum constant of this class with the specified name.

static TaskState[]

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
- 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
- Unknown
  
  public static final TaskState Unknown
Method Details
- values
  
  public static TaskState[] 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 TaskState 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
- isTerminal
  
  public boolean isTerminal()
- isCurrent
  
  public boolean isCurrent()