scriptinterface.execution.returnvalues

Class ExecutionResult<ValueType>

java.lang.Object

scriptinterface.execution.returnvalues.ExecutionReturn

scriptinterface.execution.returnvalues.ExecutionResult<ValueType>

Type Parameters:

ValueType - the type of the internal value.

Direct Known Subclasses:

GArray, GBoolean, GColor, GCompoundFile, GCompoundFiles, GDotAttributes, GEdge, GErrorHolder, GExecuterCall, GFile, GFiles, GFloat, GFormat, GGraph, GHistogram, GInteger, GInterval, GIterable, GList, GMetaEdge, GObject, GParseTree, GPositiveInteger, GSet, GString, GVector, GVertex

public abstract class ExecutionResult<ValueType>
extends ExecutionReturn

Wrapper for a result of a script execution, e.g. return values of function calls.

Field Summary

Fields inherited from class scriptinterface.execution.returnvalues.ExecutionReturn

QUIT, UNDEF, VOID

Constructor Summary

Constructors

Constructor and Description
ExecutionResult()

Method Summary

Modifier and Type	Method and Description
abstract ExecutionResult<ValueType>	clone()
boolean	equals(java.lang.Object obj) Indicates whether or not the internal value equals the internal value of the given ExecutionResult.
java.lang.String	getSign() Returns the short sign of the type.
java.lang.String	getStringRepresentation() Returns a user-readable string representation of this instance.
abstract ScriptType	getType() Returns the type of the result.
java.lang.String	getTypeName() Returns the name of the type.
abstract ValueType	getValue() Returns the internal value.
boolean	isZero() Indicates whether or not the value is zero, regardless, of which type this zero is.
abstract void	setValue(ValueType value) Sets the internal value.
java.lang.String	toString()
protected java.lang.String	valueToString() Returns the internal value as a string

Methods inherited from class scriptinterface.execution.returnvalues.ExecutionReturn

getScriptConstantRepresentation, isStopExecution

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutionResult

public ExecutionResult()

Method Detail

getValue

public abstract ValueType getValue()

Returns the internal value.

Returns:

the internal value.

setValue

public abstract void setValue(ValueType value)

Sets the internal value.

Parameters:

value - the new value.

getType

public abstract ScriptType getType()

Returns the type of the result.

Returns:

the type of the result.

clone

public abstract ExecutionResult<ValueType> clone()

Overrides:

clone in class java.lang.Object

getTypeName

public java.lang.String getTypeName()

Returns the name of the type.

Returns:

the name of the type.

getSign

public java.lang.String getSign()

Returns the short sign of the type.

Returns:

the sign of the type.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

valueToString

protected java.lang.String valueToString()

Returns the internal value as a string

Returns:

the string representation of the internal value.

getStringRepresentation

public java.lang.String getStringRepresentation()

Description copied from class: ExecutionReturn

Returns a user-readable string representation of this instance.

Overrides:

getStringRepresentation in class ExecutionReturn

Returns:

the string representation of this instance.

isZero

public boolean isZero()

Indicates whether or not the value is zero, regardless, of which type this zero is.

Returns:

true, if and only if, the internal value is 0.

equals

public boolean equals(java.lang.Object obj)

Indicates whether or not the internal value equals the internal value of the given ExecutionResult.

Overrides:

equals in class java.lang.Object

Returns:

true, if and only if, this instance and the given instance have an equal internal value.