com.eclipsesource.v8

Class V8Array

java.lang.Object

com.eclipsesource.v8.V8Value

com.eclipsesource.v8.V8Object

com.eclipsesource.v8.V8Array

All Implemented Interfaces:

Releasable

public class V8Array
extends V8Object

A V8Value that represents a JavaScript array. JavaScript Arrays contain elements by index, but can also contain elements by 'key' which is why V8Array extends V8Object.

Field Summary

Fields inherited from class com.eclipsesource.v8.V8Value

BOOLEAN, DOUBLE, INTEGER, NULL, objectHandle, released, STRING, UNDEFINED, UNKNOWN, v8, V8_ARRAY, V8_FUNCTION, V8_OBJECT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	V8Array()
	V8Array(V8 v8) Creates a new V8Array and associates it with the given runtime.

Method Summary

Methods

Modifier and Type	Method and Description
protected V8Value	createTwin()
Object	get(int index) Gets the value at a given index as a Java Object.
V8Array	getArray(int index) Returns the V8Array value associated at this index.
boolean	getBoolean(int index) Returns the boolean value associated at this index.
boolean[]	getBooleans(int index, int length) Returns the booleans contained in a subset of a V8Array.
int	getBooleans(int index, int length, boolean[] resultArray) Gets the booleans contained in a subset of a V8Array.
double	getDouble(int index) Returns the double value associated at this index.
double[]	getDoubles(int index, int length) Returns the doubles contained in a subset of a V8Array.
int	getDoubles(int index, int length, double[] resultArray) Gets the doubles contained in a subset of a V8Array.
int	getInteger(int index) Returns the integer value associated at this index.
int[]	getIntegers(int index, int length) Returns the integers contained in a subset of a V8Array.
int	getIntegers(int index, int length, int[] resultArray) Gets the integers contained in a subset of a V8Array.
V8Object	getObject(int index) Returns the V8Object value associated at this index.
String	getString(int index) Returns the String value associated at this index.
String[]	getStrings(int index, int length) Returns the Strings contained in a subset of a V8Array.
int	getStrings(int index, int length, String[] resultArray) Gets the Strings contained in a subset of a V8Array.
int	getType() Gets the type of the array.
int	getType(int index) Returns the type of element at this given index.
int	getType(int index, int length) Gets the type of a subset of the array.
protected long	initialize(long runtimePtr)
int	length() Returns the length of this array.
V8Array	push(boolean value) Pushes a boolean value to the next available spot in the Array.
V8Array	push(double value) Pushes a double value to the next available spot in the Array.
V8Array	push(int value) Pushes an integer value to the next available spot in the Array.
V8Array	push(String value) Pushes a String value to the next available spot in the Array.
V8Array	push(V8Value value) Pushes a V8Value to the next available spot in the Array.
V8Array	pushNull() Pushes null to the next available spot in the Array.
V8Array	pushUndefined() Pushes undefined to the next available spot in the Array.
V8Array	twin() Creates a new Java object pointing at the same V8 Value as this.

Methods inherited from class com.eclipsesource.v8.V8Object

add, add, add, add, add, addNull, addUndefined, contains, executeArrayFunction, executeBooleanFunction, executeDoubleFunction, executeFunction, executeIntegerFunction, executeObjectFunction, executeStringFunction, executeVoidFunction, get, getArray, getBoolean, getDouble, getInteger, getKeys, getObject, getString, getType, registerJavaMethod, registerJavaMethod, registerJavaMethod, registerJavaMethod, setPrototype, toString

Methods inherited from class com.eclipsesource.v8.V8Value

checkReleaesd, equals, getHandle, getRuntime, getRutime, hashCode, isReleased, isUndefined, jsEquals, release, strictEquals

Methods inherited from class java.lang.Object

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

Constructor Detail

V8Array

protected V8Array()

V8Array

public V8Array(V8 v8)

Creates a new V8Array and associates it with the given runtime. V8Arrays have native resources and as such, must be released.

Parameters:

v8 - The runtime on which to associate the V8Array.

Method Detail

createTwin

protected V8Value createTwin()

Overrides:

createTwin in class V8Object

twin

public V8Array twin()

Description copied from class: V8Value

Creates a new Java object pointing at the same V8 Value as this. If the value is mutated (by adding new members or changing existing ones) then both the original and twin will be updated. Twins are .equal and .strict equals, but not == in Java. Twins must be released separately since they have their own native resources.

Overrides:

twin in class V8Object

Returns:

A new Java object pointing at the same V8 Value as this.

initialize

protected long initialize(long runtimePtr)

Overrides:

initialize in class V8Value

length

public int length()

Returns the length of this array.

Returns:

The length of the array.

getType

public int getType(int index)

Returns the type of element at this given index.

Parameters:

index - The index at which to lookup the type of.

Returns:

The type of the element at the index.

getType

public int getType()

Gets the type of the array. Returns a 'type' if all the elements in the array have the same type, otherwise UNDEFINED is returned.

Returns:

The type of all the elements of the array, or UNDEFINED if they are not all the same type.

getType

public int getType(int index,
          int length)

Gets the type of a subset of the array. The subset is specified by a start index and a length. UNDEFINED is returned if all the elements in the subset are not of the same type.

Parameters:

index - The start index.

length - The length.

Returns:

The type of the subset of the array or UNDEFINED if the subset is not all the same type.

getInteger

public int getInteger(int index)

Returns the integer value associated at this index. If the value at this index does not exist, or if it's not an integer, then V8ResultUndefined exception is thrown.

Parameters:

index - The index whose value to return.

Returns:

The integer value at this index or V8ResultUndefined if the index does not exist or the value is not an integer.

getBoolean

public boolean getBoolean(int index)

Returns the boolean value associated at this index. If the value at this index does not exist, or if it's not a boolean, then V8ResultUndefined exception is thrown.

Parameters:

index - The index whose value to return.

Returns:

The boolean value at this index or V8ResultUndefined if the index does not exist or the value is not a boolean.

getDouble

public double getDouble(int index)

Returns the double value associated at this index. If the value at this index does not exist, or if it's not a double, then V8ResultUndefined exception is thrown.

Parameters:

index - The index whose value to return.

Returns:

The double value at this index or V8ResultUndefined if the index does not exist or the value is not a double.

getString

public String getString(int index)

Returns the String value associated at this index. If the value at this index does not exist, or if it's not a String, then V8ResultUndefined exception is thrown.

Parameters:

index - The index whose value to return.

Returns:

The String value at this index or V8ResultUndefined if the index does not exist or the value is not a String.

getIntegers

public int[] getIntegers(int index,
                int length)

Returns the integers contained in a subset of a V8Array. If the subset contains elements other than integers, then a V8ResultUndefined exception is thrown. Furthermore, if the subset is not entirely contained within the array, then V8ResultUndefined exception is also thrown.

Parameters:

index - The starting index.

length - The length.

Returns:

The integers contained in the subset of the array, or V8ResultUndefined exception.

getIntegers

public int getIntegers(int index,
              int length,
              int[] resultArray)

Gets the integers contained in a subset of a V8Array. If the subset contains elements other than integers, then a V8ResultUndefined exception is thrown. Furthermore, if the subset is not entirely contained within the array, then V8ResultUndefined exception is also thrown. Finally, if the resultArray is not large enough to hold the results then IndexOutOfBoundsException is thrown.

Parameters:

index - The starting index.

length - The length.

resultArray - The array to put the results in.

Returns:

The number of elements added to the array.

getDoubles

public double[] getDoubles(int index,
                  int length)

Returns the doubles contained in a subset of a V8Array. If the subset contains elements other than doubles, then a V8ResultUndefined exception is thrown. Furthermore, if the subset is not entirely contained within the array, then V8ResultUndefined exception is also thrown.

Parameters:

index - The starting index.

length - The length.

Returns:

The doubles contained in the subset of the array, or V8ResultUndefined exception.

getDoubles

public int getDoubles(int index,
             int length,
             double[] resultArray)

Gets the doubles contained in a subset of a V8Array. If the subset contains elements other than doubles, then a V8ResultUndefined exception is thrown. Furthermore, if the subset is not entirely contained within the array, then V8ResultUndefined exception is also thrown. Finally, if the resultArray is not large enough to hold the results then IndexOutOfBoundsException is thrown.

Parameters:

index - The starting index.

length - The length.

resultArray - The array to put the results in.

Returns:

The number of elements added to the array.

getBooleans

public boolean[] getBooleans(int index,
                    int length)

Returns the booleans contained in a subset of a V8Array. If the subset contains elements other than booleans, then a V8ResultUndefined exception is thrown. Furthermore, if the subset is not entirely contained within the array, then V8ResultUndefined exception is also thrown.

Parameters:

index - The starting index.

length - The length.

Returns:

The booleans contained in the subset of the array, or V8ResultUndefined exception.

getBooleans

public int getBooleans(int index,
              int length,
              boolean[] resultArray)

Gets the booleans contained in a subset of a V8Array. If the subset contains elements other than booleans, then a V8ResultUndefined exception is thrown. Furthermore, if the subset is not entirely contained within the array, then V8ResultUndefined exception is also thrown. Finally, if the resultArray is not large enough to hold the results then IndexOutOfBoundsException is thrown.

Parameters:

index - The starting index.

length - The length.

resultArray - The array to put the results in.

Returns:

The number of elements added to the array.

getStrings

public String[] getStrings(int index,
                  int length)

Returns the Strings contained in a subset of a V8Array. If the subset contains elements other than Strings, then a V8ResultUndefined exception is thrown. Furthermore, if the subset is not entirely contained within the array, then V8ResultUndefined exception is also thrown.

Parameters:

index - The starting index.

length - The length.

Returns:

The Strings contained in the subset of the array, or V8ResultUndefined exception.

getStrings

public int getStrings(int index,
             int length,
             String[] resultArray)

Gets the Strings contained in a subset of a V8Array. If the subset contains elements other than Strings, then a V8ResultUndefined exception is thrown. Furthermore, if the subset is not entirely contained within the array, then V8ResultUndefined exception is also thrown. Finally, if the resultArray is not large enough to hold the results then IndexOutOfBoundsException is thrown.

Parameters:

index - The starting index.

length - The length.

resultArray - The array to put the results in.

Returns:

The number of elements added to the array.

get

public Object get(int index)

Gets the value at a given index as a Java Object. Primitives are boxed.

Parameters:

index - The index to get the value at.

Returns:

The value at the given index.

getArray

public V8Array getArray(int index)

Returns the V8Array value associated at this index. If the value at this index does not exist, or if it's not a V8Array, then V8ResultUndefined exception is thrown.

Parameters:

index - The index whose value to return.

Returns:

The V8Array value at this index or V8ResultUndefined if the index does not exist or the value is not a V8Array.

getObject

public V8Object getObject(int index)

Returns the V8Object value associated at this index. If the value at this index does not exist, or if it's not a V8Object, then V8ResultUndefined exception is thrown.

Parameters:

index - The index whose value to return.

Returns:

The V8Object value at this index or V8ResultUndefined if the index does not exist or the value is not a V8Object.

push

public V8Array push(int value)

Pushes an integer value to the next available spot in the Array. In particular, this[length] = value;

Parameters:

value - The value to push to the array.

Returns:

The receiver.

push

public V8Array push(boolean value)

Pushes a boolean value to the next available spot in the Array. In particular, this[length] = value;

Parameters:

value - The value to push to the array.

Returns:

The receiver.

push

public V8Array push(double value)

Pushes a double value to the next available spot in the Array. In particular, this[length] = value;

Parameters:

value - The value to push to the array.

Returns:

The receiver.

push

public V8Array push(String value)

Pushes a String value to the next available spot in the Array. In particular, this[length] = value;

Parameters:

value - The value to push to the array.

Returns:

The receiver.

push

public V8Array push(V8Value value)

Pushes a V8Value to the next available spot in the Array. In particular, this[length] = value;

Parameters:

value - The value to push to the array.

Returns:

The receiver.

pushNull

public V8Array pushNull()

Pushes null to the next available spot in the Array. In particular, this[length] = null;

Parameters:

value - The value to push to the array.

Returns:

The receiver.

pushUndefined

public V8Array pushUndefined()

Pushes undefined to the next available spot in the Array. In particular, this[length] = undefined;

Parameters:

value - The value to push to the array.

Returns:

The receiver.