Enum ScriptInstance.State

java.lang.Object

java.lang.Enum<ScriptInstance.State>

com.blackrook.rookscript.ScriptInstance.State

All Implemented Interfaces:

Serializable, Comparable<ScriptInstance.State>

Enclosing class:

ScriptInstance

public static enum ScriptInstance.State
extends Enum<ScriptInstance.State>

Enumeration of script states.

Since:

1.8.0, Script Scope attachment is done on the script, not the instance.

Author:

Matthew Tropiano

Enum Constant Summary

Enum Constants

Enum Constant	Description
CREATED	Created, not executed yet.
ENDED	Ended - awaiting cleanup.
INIT	Not executed yet.
RUNNING	Currently running.
SUSPENDED	Manually suspended.
WAITING	Waiting on some kind of action to complete.

Method Summary

Modifier and Type	Method	Description
static ScriptInstance.State	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ScriptInstance.State[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CREATED

public static final ScriptInstance.State CREATED

Created, not executed yet.

INIT

public static final ScriptInstance.State INIT

Not executed yet.

RUNNING

public static final ScriptInstance.State RUNNING

Currently running.

WAITING

public static final ScriptInstance.State WAITING

Waiting on some kind of action to complete.

SUSPENDED

public static final ScriptInstance.State SUSPENDED

Manually suspended.

ENDED

public static final ScriptInstance.State ENDED

Ended - awaiting cleanup.

Method Details

values

public static ScriptInstance.State[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

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

valueOf

public static ScriptInstance.State valueOf(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:

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

NullPointerException - if the argument is null