scriptinterface.execution.returnvalues

Class ExecutionReturn

java.lang.Object

scriptinterface.execution.returnvalues.ExecutionReturn

Direct Known Subclasses:

ExecutionError, ExecutionFunctionReturn, ExecutionResult

public abstract class ExecutionReturn
extends java.lang.Object

Can be returned by a function call. This includes results, errors etc.

Field Summary

Fields

Modifier and Type	Field and Description
static ExecutionReturn	QUIT Supposed to quit the program if returned.
static ExecutionReturn	UNDEF Indicates, that something is undefined.
static ExecutionReturn	VOID Indicates, that there is no value.

Constructor Summary

Constructors

Constructor and Description
ExecutionReturn()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getScriptConstantRepresentation() Returns the value as a constant in valid script syntax.
java.lang.String	getStringRepresentation() Returns a user-readable string representation of this instance.
boolean	isStopExecution() Indicates whether or not this execution return is a reason to interrupt script execution (e.g. error).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VOID

public static final ExecutionReturn VOID

Indicates, that there is no value. Can for example be returned in functions which do not return a result.

UNDEF

public static final ExecutionReturn UNDEF

Indicates, that something is undefined.

QUIT

public static final ExecutionReturn QUIT

Supposed to quit the program if returned.

Constructor Detail

ExecutionReturn

public ExecutionReturn()

Method Detail

isStopExecution

public boolean isStopExecution()

Indicates whether or not this execution return is a reason to interrupt script execution (e.g. error).

Returns:

true, if and only if script execution should be stopped.

getStringRepresentation

public java.lang.String getStringRepresentation()

Returns a user-readable string representation of this instance.

Returns:

the string representation of this instance.

getScriptConstantRepresentation

public java.lang.String getScriptConstantRepresentation()

Returns the value as a constant in valid script syntax.

Returns:

the value in its constant representation.