com.newisys.ova
Enum OVAEngineAction

java.lang.Object
  java.lang.Enum<OVAEngineAction>
      com.newisys.ova.OVAEngineAction

All Implemented Interfaces:

Serializable, Comparable<OVAEngineAction>

public enum OVAEngineAction
extends Enum<OVAEngineAction>

Actions that can be performed on an OVAEngine via its OVAEngine.doAction(com.newisys.ova.OVAEngineAction) method.

Enum Constant Summary

Finish
Stops the OVA engine.

Reset
Stops all attempts at matching assertions.

Terminate
TODO: document Terminate

Method Summary

int	getValue() Returns the integer value associated with this OVAEngineAction.
static OVAEngineAction	valueOf(String name) Returns the enum constant of this type with the specified name.
static OVAEngineAction[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Reset

public static final OVAEngineAction Reset

Stops all attempts at matching assertions. Attempts are re-enabled on the following clock cycle.

Finish

public static final OVAEngineAction Finish

Stops the OVA engine. All further matching attempts are stopped. The engine cannot be re-enabled.

Terminate

public static final OVAEngineAction Terminate

TODO: document Terminate

Method Detail

values

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

Returns:

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

valueOf

public static OVAEngineAction valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

getValue

public int getValue()

Returns the integer value associated with this OVAEngineAction.

Returns:

the integer value of this enumeration