Package com.inductiveautomation.ignition.common.execution

Enum Class PollingFuture.State

java.lang.Object

java.lang.Enum<PollingFuture.State>

com.inductiveautomation.ignition.common.execution.PollingFuture.State

All Implemented Interfaces:

Serializable, Comparable<PollingFuture.State>, Constable

Enclosing class:

PollingFuture<V>

protected static enum PollingFuture.State
extends Enum<PollingFuture.State>

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
IDLE
RUNNING	Task is currently executing.
RUNNING_DIRTY	Task is currently executing, but with dirty inputs, and needs to be re-run asap.
SCHEDULED	A task is submitted to the scheduler to run PollingFuture.fetchValue() in the future
SHUTDOWN

Method Summary

Modifier and Type	Method	Description
static PollingFuture.State	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PollingFuture.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

IDLE

public static final PollingFuture.State IDLE

SCHEDULED

public static final PollingFuture.State SCHEDULED

A task is submitted to the scheduler to run PollingFuture.fetchValue() in the future

RUNNING

public static final PollingFuture.State RUNNING

Task is currently executing.

RUNNING_DIRTY

public static final PollingFuture.State RUNNING_DIRTY

Task is currently executing, but with dirty inputs, and needs to be re-run asap.

SHUTDOWN

public static final PollingFuture.State SHUTDOWN

Method Details

values

public static PollingFuture.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 PollingFuture.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