Package edu.cnu.mdi.sim

Enum Class CompletionStatus

java.lang.Object

java.lang.Enum<CompletionStatus>

edu.cnu.mdi.sim.CompletionStatus

All Implemented Interfaces:

Serializable, Comparable<CompletionStatus>, Constable

public enum CompletionStatus
extends Enum<CompletionStatus>

Describes why a SimulationEngine reached a terminal state.

The status is delivered exactly once through SimulationListener.onCompleted(SimulationContext, CompletionStatus, Throwable). It supplements, rather than replaces, the original lifecycle callbacks. In particular, existing listeners continue to receive onDone, onFail, and onCancelRequested with their established semantics.

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
CANCELLED	The engine terminated in response to cooperative cancellation.
FAILED	Initialization, execution, or another engine-managed operation failed.
STOPPED	The engine terminated in response to SimulationEngine.requestStop().
SUCCEEDED	The simulation returned false from Simulation.step(edu.cnu.mdi.sim.SimulationContext).

Method Summary

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

SUCCEEDED

public static final CompletionStatus SUCCEEDED

The simulation returned false from Simulation.step(edu.cnu.mdi.sim.SimulationContext).

STOPPED

public static final CompletionStatus STOPPED

The engine terminated in response to SimulationEngine.requestStop().

CANCELLED

public static final CompletionStatus CANCELLED

The engine terminated in response to cooperative cancellation.

FAILED

public static final CompletionStatus FAILED

Initialization, execution, or another engine-managed operation failed.

Method Details

values

public static CompletionStatus[] 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 CompletionStatus 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