Package com.amalgamasimulation.studies.core

Enum Class Run.Status

java.lang.Object

java.lang.Enum<Run.Status>

com.amalgamasimulation.studies.core.Run.Status

All Implemented Interfaces:

Serializable, Comparable<Run.Status>, Constable

Enclosing class:

Run<S extends org.eclipse.emf.ecore.EObject>

public static enum Run.Status
extends Enum<Run.Status>

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
COMPLETED	Run has finished execution, either normally or with an error reported as part of the result.
ERROR	Run was unable to complete due to an unexpected external exception not related to the experiment logic.
IN_PROGRESS	Run has been started by calling Run.run() method and is currently in progress.
IN_QUEUE	Run has been queued for execution but hasn't started processing yet.
NOT_STARTED	Run is created but not yet started.

Method Summary

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

NOT_STARTED

public static final Run.Status NOT_STARTED

Run is created but not yet started. In this status:

• The run already has its Run.id() represented by ShortId instance. Once a run is created, its id never changes.
• Run.result() is equal to Optional.empty() as there is no result yet.
• Run.completedFraction() returns 0 as no part of the experiment has been completed yet.
• Run.elapsedTimeMillis() returns 0 as no time has been spent executing the run

IN_QUEUE

public static final Run.Status IN_QUEUE

Run has been queued for execution but hasn't started processing yet. In this status:

• The run already has its Run.id() represented by ShortId instance. Once a run is created, its id never changes.
• Run.result() is equal to Optional.empty() as there is no result yet.
• Run.completedFraction() returns 0 as no part of the experiment has been completed yet.
• Run.elapsedTimeMillis() returns 0 as no time has been spent executing the run

IN_PROGRESS

public static final Run.Status IN_PROGRESS

Run has been started by calling Run.run() method and is currently in progress. In this status:

• Run.result() is still equal to Optional.empty() as the result is only produced after the run finishes (normally or due to an error).
• Run.completedFraction() returns a value between 0 and 1 representing the fraction of the experiment that has been completed.
• Run.elapsedTimeMillis() returns a non-negative number of milliseconds elapsed from calling the Run.run() method

COMPLETED

public static final Run.Status COMPLETED

Run has finished execution, either normally or with an error reported as part of the result. In this status:

• Run.result() is not empty and contains an instance of Result. Note that the result itself may indicate that errors occurred during execution. Use Result.hasErrors() to check it.
• Run.completedFraction() returns a value between 0 and 1 representing the fraction of the experiment that was completed. Normally, if the run finishes successfully, Run.completedFraction() returns 1.
• Run.elapsedTimeMillis() returns a non-negative number of milliseconds the run spent in IN_PROGRESS status.

ERROR

public static final Run.Status ERROR

Run was unable to complete due to an unexpected external exception not related to the experiment logic. A result has not been produced. In this status:

• Run.result() is equal to Optional.empty() as the result could not be reliably calculated or obtained due to the error.
• Run.completedFraction() returns a value between 0 and 1 representing the fraction of the experiment that was completed before the failure occurred.
• Run.elapsedTimeMillis() returns a non-negative number of milliseconds the run spent in IN_PROGRESS status.

Method Details

values

public static Run.Status[] 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 Run.Status 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

isFinal

public boolean isFinal()