com.scriptbasic.executors.rightvalues

Class BasicArrayValue

java.lang.Object

com.scriptbasic.executors.AbstractValue

com.scriptbasic.executors.rightvalues.AbstractRightValue

com.scriptbasic.executors.rightvalues.BasicArrayValue

All Implemented Interfaces:

RightValue, Value

public class BasicArrayValue
extends AbstractRightValue

Constructor Summary

Constructors

Constructor and Description
BasicArrayValue() This constructor can be used by extension classes to instantiate a new BasicArrayValue when the extension function does not have access to the interpreter.
BasicArrayValue(ExtendedInterpreter interpreter) Create a new BasicArrayValue and remember the interpreter.

Method Summary

Methods

Modifier and Type	Method and Description
Object	get(Integer index) Get the index-th element of the array.
Long	getLength() Get the length of the array.
void	set(Integer index, Object object) Set the index-th element of the array
void	setArray(Object[] array) Set the array object.
void	setInterpreter(ExtendedInterpreter interpreter) Set the interpreter that this array belongs to.

Methods inherited from class com.scriptbasic.executors.rightvalues.AbstractRightValue

isArray, isBoolean, isDouble, isJavaObject, isLong, isNumeric, isString

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicArrayValue

public BasicArrayValue()

This constructor can be used by extension classes to instantiate a new BasicArrayValue when the extension function does not have access to the interpreter.

Note that in later versions this constructor will be deprecated as soon as the interface of the extensions will make it possible to pass the interpreter along to the extension methods.

BasicArrayValue

public BasicArrayValue(ExtendedInterpreter interpreter)

Create a new BasicArrayValue and remember the interpreter.

The interpreter can determine the maximum size allowed for arrays and therefore may suggest for a BasicArrayValue not to extend its size, but rather throw exception. This is to prevent allocating extraordinary large arrays in an interpreter by mistake.

Parameters:

interpreter -

Method Detail

setArray

public void setArray(Object[] array)

Set the array object. This method is available as a convenience method for extension methods and is not used by the interpreter. This method can be used when the array is available from some calculation and it would be waste of resource to copy the elements of the array one by one calling set(Integer, Object).

Parameters:

array - the array

Throws:

NullPointerException - when the array is null

setInterpreter

public void setInterpreter(ExtendedInterpreter interpreter)

Set the interpreter that this array belongs to.

Note that this method is used only from the code where the interpreter calls an extension method that returns a BasicArrayValue. In that case the parameter less constructor of this class is called by the extension method and thus the BasicArrayValue does not know the interpreter and can not request suggestion from the interpreter to perform resizing or throw exception.

When the parameterless version of the constructor becomes deprecated this setter will also become deprecated.

Parameters:

interpreter -

getLength

public Long getLength()

Get the length of the array. This is not the length of the underlying object array but the size that the BASIC program should feel.

Returns:

the length of the array, which is n+1, where n is the maximal index of the array the BASIC program ever used.

set

public void set(Integer index,
       Object object)
         throws ExecutionException

Set the index-th element of the array

Parameters:

index -

object - the new value for the array

Throws:

ExecutionException

get

public Object get(Integer index)
           throws ExecutionException

Get the index-th element of the array. Note that this method does NOT convert the value to an ordinary Java object. Thus when calling this method from an extension method be prepared to convert the value to ordinary Java object yourself.

Parameters:

index -

Returns:

the array element.

Throws:

ExecutionException