Package com.inductiveautomation.sfc

Enum ElementStateEnum

java.lang.Object

java.lang.Enum<ElementStateEnum>

com.inductiveautomation.sfc.ElementStateEnum

All Implemented Interfaces:

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

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

Enum Constant Summary

Enum Constants

Enum Constant	Description
Aborted
Aborting
Activating
Active
Canceled
Cancelling
Deactivating
Inactive
Paused
Pausing
Resuming

Method Summary

Modifier and Type	Method	Description
boolean	isRunning()	Returns true as long as we're not one of the stopped states: aborted, paused, inactive, or canceled.
static ElementStateEnum	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static ElementStateEnum[]	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

Aborting

public static final ElementStateEnum Aborting

Aborted

public static final ElementStateEnum Aborted

Activating

public static final ElementStateEnum Activating

Active

public static final ElementStateEnum Active

Deactivating

public static final ElementStateEnum Deactivating

Inactive

public static final ElementStateEnum Inactive

Pausing

public static final ElementStateEnum Pausing

Paused

public static final ElementStateEnum Paused

Resuming

public static final ElementStateEnum Resuming

Cancelling

public static final ElementStateEnum Cancelling

Canceled

public static final ElementStateEnum Canceled

Method Detail

values

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

Returns:

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

valueOf

public static ElementStateEnum 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

isRunning

public boolean isRunning()

Returns true as long as we're not one of the stopped states: aborted, paused, inactive, or canceled. Transitioning states still return true.