Package mars.simulator

Class SimulatorFinishEvent

java.lang.Object

java.util.EventObject

mars.simulator.SimulatorFinishEvent

All Implemented Interfaces:

Serializable

public class SimulatorFinishEvent
extends EventObject

Event for when the simulator stops execution of a program due to termination or finishing. Note that the return value of EventObject.getSource() will always be a Simulator.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SimulatorFinishEvent.Reason	Enumeration of reasons for why the simulator might finish or terminate.

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
SimulatorFinishEvent(Simulator simulator, SimulatorFinishEvent.Reason reason, SimulatorException exception)	Construct a new event with the given parameters.

Method Summary

Modifier and Type	Method	Description
SimulatorException	getException()	The exception causing the program to terminate (only applies to SimulatorFinishEvent.Reason.EXCEPTION).
SimulatorFinishEvent.Reason	getReason()	The reason why the program finished or terminated.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

SimulatorFinishEvent

public SimulatorFinishEvent(Simulator simulator,
 SimulatorFinishEvent.Reason reason,
 SimulatorException exception)

Construct a new event with the given parameters.

Parameters:

simulator - The source of this event.

reason - The reason why the program finished or terminated.

exception - The exception causing the program to terminate (only applies to SimulatorFinishEvent.Reason.EXCEPTION).

Method Details

getReason

public SimulatorFinishEvent.Reason getReason()

The reason why the program finished or terminated.

getException

public SimulatorException getException()

The exception causing the program to terminate (only applies to SimulatorFinishEvent.Reason.EXCEPTION).