com.newisys.ova
Enum OVAEngineEventType

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

All Implemented Interfaces:

Serializable, Comparable<OVAEngineEventType>

public enum OVAEngineEventType
extends Enum<OVAEngineEventType>

Enumeration of event types for OVAEngine objects.

Enum Constant Summary

All
Corresponds to all events that occur on an OVAEngine

EngineError
The OVAEngine has encountered an error.

EngineFinished
The OVAEngine has finished.

EngineStarted
The OVAEngine has started.

InitializeBegin
The OVAEngine has started initializing.

InitializeEnd
The OVAEngine has completed initializing.

LoadBegin
TODO: document LoadBegin

LoadEnd
TODO: document LoadBegin

ResetBegin
The OVAEngine has started resetting.

ResetEnd
The OVAEngine has completed resetting.

TerminateBegin
The OVAEngine has started terminating.

TerminateEnd
The OVAEngine has completed terminating.

Method Summary

static OVAEngineEventType	forValue(int value) Returns the OVAEngineEventType for the given integer value.
int	getValue() Returns the integer value associated with this OVAEngineEventType.
static OVAEngineEventType	valueOf(String name) Returns the enum constant of this type with the specified name.
static OVAEngineEventType[]	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

All

public static final OVAEngineEventType All

Corresponds to all events that occur on an OVAEngine

InitializeBegin

public static final OVAEngineEventType InitializeBegin

The OVAEngine has started initializing.

InitializeEnd

public static final OVAEngineEventType InitializeEnd

The OVAEngine has completed initializing.

EngineStarted

public static final OVAEngineEventType EngineStarted

The OVAEngine has started.

ResetBegin

public static final OVAEngineEventType ResetBegin

The OVAEngine has started resetting.

ResetEnd

public static final OVAEngineEventType ResetEnd

The OVAEngine has completed resetting.

LoadBegin

public static final OVAEngineEventType LoadBegin

TODO: document LoadBegin

LoadEnd

public static final OVAEngineEventType LoadEnd

TODO: document LoadBegin

EngineFinished

public static final OVAEngineEventType EngineFinished

The OVAEngine has finished.

TerminateBegin

public static final OVAEngineEventType TerminateBegin

The OVAEngine has started terminating.

TerminateEnd

public static final OVAEngineEventType TerminateEnd

The OVAEngine has completed terminating.

EngineError

public static final OVAEngineEventType EngineError

The OVAEngine has encountered an error.

Method Detail

values

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

Returns:

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

valueOf

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

Returns:

the integer value for this enumeration

forValue

public static OVAEngineEventType forValue(int value)

Returns the OVAEngineEventType for the given integer value.

Parameters:

value - the value for which to return an OVAEngineEventType

Returns:

the OVAEngineEventType corresponding to value

Throws:

IllegalArgumentException - if value does not correspond to any OVAEngineEventType