Package mars.simulator

Enum Class SimulatorPauseEvent.Reason

java.lang.Object

java.lang.Enum<SimulatorPauseEvent.Reason>

mars.simulator.SimulatorPauseEvent.Reason

All Implemented Interfaces:

Serializable, Comparable<SimulatorPauseEvent.Reason>, Constable

Enclosing class:

SimulatorPauseEvent

public static enum SimulatorPauseEvent.Reason
extends Enum<SimulatorPauseEvent.Reason>

Enumeration of reasons for why the simulator might pause.

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
BREAKPOINT	A breakpoint was reached, causing execution to pause.
EXTERNAL	Execution was paused by something outside of the simulator.
STEP_LIMIT_REACHED	The requested number of steps have completed successfully, causing execution to pause.

Method Summary

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

STEP_LIMIT_REACHED

public static final SimulatorPauseEvent.Reason STEP_LIMIT_REACHED

The requested number of steps have completed successfully, causing execution to pause. This is also used when stepping one step at a time.

BREAKPOINT

public static final SimulatorPauseEvent.Reason BREAKPOINT

A breakpoint was reached, causing execution to pause.

EXTERNAL

public static final SimulatorPauseEvent.Reason EXTERNAL

Execution was paused by something outside of the simulator. This is usually caused by the Pause action.

Method Details

values

public static SimulatorPauseEvent.Reason[] 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 SimulatorPauseEvent.Reason 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