cz.zcu.fav.kiv.jsim
Enum JSimSimulationState

java.lang.Object
  java.lang.Enum<JSimSimulationState>
      cz.zcu.fav.kiv.jsim.JSimSimulationState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<JSimSimulationState>

public enum JSimSimulationState
extends java.lang.Enum<JSimSimulationState>

During simulation program execution, the simulation object can be in one of the following states:

• Not Started Yet
• In Progress
• Terminated

Since:

J-Sim version 0.6.0

Version:

J-Sim version 0.6.0

Author:

Jarda KAČER

Enum Constant Summary

IN_PROGRESS

NOT_STARTED

TERMINATED

Field Summary

private java.lang.String

humanReadableDescription A human-readable description of the simulation state.

Method Summary

java.lang.String	toString() Returns a human-readable description of the simulation mode.
static JSimSimulationState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static JSimSimulationState[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NOT_STARTED

public static final JSimSimulationState NOT_STARTED

IN_PROGRESS

public static final JSimSimulationState IN_PROGRESS

TERMINATED

public static final JSimSimulationState TERMINATED

Field Detail

humanReadableDescription

private final java.lang.String humanReadableDescription

A human-readable description of the simulation state.

Method Detail

values

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

Returns:

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

valueOf

public static JSimSimulationState valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

toString

public java.lang.String toString()

Returns a human-readable description of the simulation mode.

Overrides:

toString in class java.lang.Enum<JSimSimulationState>

Returns:

A human-readable description of the simulation mode.

See Also:

Enum.toString()