com.ace.moab.api.triggers
Enum TriggerState

java.lang.Object
  java.lang.Enum<TriggerState>
      com.ace.moab.api.triggers.TriggerState

All Implemented Interfaces:

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

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

This enum describes the state of a trigger.

Enum Constant Summary

ACTIVE
The trigger has fired and is currently running.

FAILURE
The trigger has failed in some way.

IDLE
The trigger is armed, but has not fired.

SUCCESSFUL
The trigger has fired and completed its task successfully

Method Summary

static TriggerState	parseString(java.lang.String string) Parses a string and converts it into a TriggerState enum value if possible.
java.lang.String	toString()
static TriggerState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TriggerState[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ACTIVE

public static final TriggerState ACTIVE

The trigger has fired and is currently running.

SUCCESSFUL

public static final TriggerState SUCCESSFUL

The trigger has fired and completed its task successfully

FAILURE

public static final TriggerState FAILURE

The trigger has failed in some way.

IDLE

public static final TriggerState IDLE

The trigger is armed, but has not fired.

Method Detail

values

public static final TriggerState[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(TriggerState c : TriggerState.values())
        System.out.println(c);

Returns:

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

valueOf

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

parseString

public static TriggerState parseString(java.lang.String string)
                                throws java.lang.IllegalArgumentException

Parses a string and converts it into a TriggerState enum value if possible.

Parameters:

string - the string to be parsed.

Returns:

the corresponding TriggerState enum value.

Throws:

java.lang.IllegalArgumentException - if the String cannot be parsed.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<TriggerState>