com.caoccao.javet.values.reference

Class V8ValueTypedArray

java.lang.Object

com.caoccao.javet.values.V8Data

com.caoccao.javet.values.V8Value

com.caoccao.javet.values.reference.V8ValueReference

com.caoccao.javet.values.reference.V8ValueObject

com.caoccao.javet.values.reference.V8ValueTypedArray

All Implemented Interfaces:

IJavetClosable, IV8Cloneable, IV8Value, IV8ValueObject, IV8ValueReference, IV8ValueTypedArray, java.lang.AutoCloseable

public class V8ValueTypedArray
extends V8ValueObject
implements IV8ValueTypedArray

The type V8 value typed array. The typical way of manipulating the typed array is as following. 1. Get array buffer and apply try-with-resource. 2. Create the value array by length. 3. Fill the value array.

E.g.:

 try (V8ValueArrayBuffer v8ValueArrayBuffer = v8ValueTypedArray.getArrayBuffer()) {
     long[] longs = new long[v8ValueArrayBuffer.getLength()];
     v8ValueArrayBuffer.toLongs(longs);
     // ...
 }
 

Or, play with ByteBuffer directly. 1. Get array buffer and apply try-with-resource. 2. Get native ByteBuffer. 3. Set order of the native ByteBuffer to native order. 4. Get typed buffer by type. 5. Read from or write to the typed buffer.

E.g:

 try (V8ValueArrayBuffer v8ValueArrayBuffer = v8ValueTypedArray.getArrayBuffer()) {
     LongBuffer longBuffer = v8ValueArrayBuffer.getByteBuffer().order(ByteOrder.nativeOrder()).asLongBuffer();
     // ...
 }
 

Since:

0.7.2

Field Summary

Fields

Modifier and Type	Field and Description
static int	EIGHT_BYTES_PER_VALUE The constant EIGHT_BYTES_PER_VALUE.
static int	FOUR_BYTES_PER_VALUE The constant FOUR_BYTES_PER_VALUE.
static int	ONE_BYTE_PER_VALUE The constant ONE_BYTE_PER_VALUE.
static java.lang.String	PROPERTY_BUFFER The constant PROPERTY_BUFFER.
static java.lang.String	PROPERTY_BYTE_LENGTH The constant PROPERTY_BYTE_LENGTH.
static java.lang.String	PROPERTY_BYTE_OFFSET The constant PROPERTY_BYTE_OFFSET.
static java.lang.String	PROPERTY_NAME The constant PROPERTY_NAME.
protected int	sizeInBytes The Size in bytes.
static int	TWO_BYTES_PER_VALUE The constant TWO_BYTES_PER_VALUE.
protected V8ValueReferenceType	type The Type.
static int	ZERO_BYTE_PER_VALUE The constant ZERO_BYTE_PER_VALUE.

Fields inherited from class com.caoccao.javet.values.reference.V8ValueObject

ERROR_THE_KEY_VALUE_PAIR_MUST_MATCH, FUNCTION_ADD, FUNCTION_DELETE, FUNCTION_GET, FUNCTION_HAS, FUNCTION_SET, METHOD_PREFIX_GET, METHOD_PREFIX_IS, METHOD_PREFIX_SET, PROPERTY_PROTOTYPE

Fields inherited from class com.caoccao.javet.values.reference.V8ValueReference

handle, INVALID_HANDLE, weak

Fields inherited from class com.caoccao.javet.values.V8Value

OBJECT_CONVERTER, v8Runtime

Fields inherited from interface com.caoccao.javet.values.reference.IV8ValueObject

DEFAULT_BATCH_SIZE, MIN_BATCH_SIZE

Method Summary

Modifier and Type	Method and Description
boolean	fromBytes(byte[] bytes) From byte array.
boolean	fromDoubles(double[] doubles) From double array.
boolean	fromFloats(float[] floats) From float array.
boolean	fromIntegers(int[] integers) From integer array.
boolean	fromLongs(long[] longs) From long array.
boolean	fromShorts(short[] shorts) From short array.
<T extends V8Value> T	get(java.lang.Object key) Get property value by key object.
V8ValueArrayBuffer	getBuffer()
int	getByteLength()
int	getByteOffset()
int	getLength()
int	getSizeInBytes()
V8ValueReferenceType	getType()
boolean	isValid()
protected void	setType(V8ValueReferenceType type) Sets type.
byte[]	toBytes() To byte array.
double[]	toDoubles() To double array.
float[]	toFloats() To float array.
int[]	toIntegers() To int array.
long[]	toLongs() To long array.
short[]	toShorts() To short array.

Methods inherited from class com.caoccao.javet.values.reference.V8ValueObject

batchGet, bind, bindFunction, bindProperty, delete, deletePrivateProperty, forEach, forEach, getBoolean, getDouble, getIdentityHash, getInteger, getLong, getOwnPropertyNames, getPrivateProperty, getProperty, getPropertyNames, getPrototype, getString, has, hasInternalType, hasOwnProperty, hasPrivateProperty, invokeExtended, invokeExtended, sameValue, set, set, setBoolean, setDouble, setInteger, setLong, setNull, setPrivateProperty, setProperty, setPrototype, setString, setUndefined, strictEquals, toJsonString, toProtoString, unbind, unbindFunction, unbindProperty, unbindProperty, unbindProperty, unbindProperty

Methods inherited from class com.caoccao.javet.values.reference.V8ValueReference

addReference, checkV8Runtime, clearWeak, close, close, equals, getHandle, isClosed, isWeak, isWeak, removeReference, setWeak, toClone, toString

Methods inherited from class com.caoccao.javet.values.V8Value

getV8Runtime

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.caoccao.javet.values.reference.IV8ValueObject

batchGet, bind, bindFunction, bindFunction, bindFunction, bindProperty, bindProperty, delete, deleteNull, deletePrivateProperty, deleteUndefined, forEach, forEach, forEach, forEach, forEach, forEach, forEach, forEach, getBigInteger, getBoolean, getDouble, getFloat, getIdentityHash, getInteger, getLong, getNull, getObject, getOwnPropertyNames, getOwnPropertyNameStrings, getPrivateProperty, getPrivatePropertyBoolean, getPrivatePropertyDouble, getPrivatePropertyFloat, getPrivatePropertyInteger, getPrivatePropertyLong, getPrivatePropertyNull, getPrivatePropertyObject, getPrivatePropertyPrimitive, getPrivatePropertyString, getPrivatePropertyUndefined, getPrivatePropertyZonedDateTime, getProperty, getPropertyBoolean, getPropertyDouble, getPropertyFloat, getPropertyInteger, getPropertyLong, getPropertyNames, getPropertyObject, getPropertyPrimitive, getPropertyString, getPropertyZonedDateTime, getPrototype, getString, getUndefined, getZonedDateTime, has, hasInternalType, hasNull, hasOwnProperty, hasPrivateProperty, hasUndefined, invoke, invoke, invokeBigInteger, invokeBoolean, invokeDouble, invokeExtended, invokeExtended, invokeFloat, invokeInteger, invokeLong, invokeObject, invokeString, invokeVoid, invokeVoid, invokeZonedDateTime, isGeneratorObject, set, set, setBoolean, setDouble, setInteger, setLong, setNull, setPrivateProperty, setPrivatePropertyNull, setPrivatePropertyUndefined, setProperty, setPropertyNull, setPropertyUndefined, setPrototype, setString, setUndefined, toJsonString, toProtoString, unbind, unbindFunction, unbindFunction, unbindFunction, unbindProperty, unbindProperty, unbindProperty, unbindProperty

Methods inherited from interface com.caoccao.javet.values.reference.IV8ValueReference

clearWeak, close, getHandle, isClosed, isWeak, isWeak, setWeak

Methods inherited from interface com.caoccao.javet.values.IV8Value

asBoolean, asDouble, asInt, asLong, asString, equals, getV8Runtime, isNull, isNullOrUndefined, isUndefined, sameValue, strictEquals

Methods inherited from interface com.caoccao.javet.interfaces.IJavetClosable

close

Methods inherited from interface com.caoccao.javet.interop.IV8Cloneable

toClone, toClone

Field Detail

PROPERTY_BYTE_LENGTH

public static final java.lang.String PROPERTY_BYTE_LENGTH

The constant PROPERTY_BYTE_LENGTH.

Since:

0.7.2

See Also:

Constant Field Values

PROPERTY_BUFFER

public static final java.lang.String PROPERTY_BUFFER

The constant PROPERTY_BUFFER.

Since:

0.7.2

See Also:

Constant Field Values

PROPERTY_BYTE_OFFSET

public static final java.lang.String PROPERTY_BYTE_OFFSET

The constant PROPERTY_BYTE_OFFSET.

Since:

0.7.2

See Also:

Constant Field Values

PROPERTY_NAME

public static final java.lang.String PROPERTY_NAME

The constant PROPERTY_NAME.

Since:

0.7.2

See Also:

Constant Field Values

ONE_BYTE_PER_VALUE

public static final int ONE_BYTE_PER_VALUE

The constant ONE_BYTE_PER_VALUE.

Since:

0.7.2

See Also:

Constant Field Values

TWO_BYTES_PER_VALUE

public static final int TWO_BYTES_PER_VALUE

The constant TWO_BYTES_PER_VALUE.

Since:

0.7.2

See Also:

Constant Field Values

FOUR_BYTES_PER_VALUE

public static final int FOUR_BYTES_PER_VALUE

The constant FOUR_BYTES_PER_VALUE.

Since:

0.7.2

See Also:

Constant Field Values

EIGHT_BYTES_PER_VALUE

public static final int EIGHT_BYTES_PER_VALUE

The constant EIGHT_BYTES_PER_VALUE.

Since:

0.7.2

See Also:

Constant Field Values

ZERO_BYTE_PER_VALUE

public static final int ZERO_BYTE_PER_VALUE

The constant ZERO_BYTE_PER_VALUE.

Since:

0.7.2

See Also:

Constant Field Values

sizeInBytes

protected int sizeInBytes

The Size in bytes.

Since:

0.7.2

type

protected V8ValueReferenceType type

The Type.

Since:

0.8.4

Method Detail

fromBytes

public boolean fromBytes(byte[] bytes)
                  throws JavetException

From byte array.

Parameters:

bytes - the byte array

Returns:

the boolean

Throws:

JavetException - the javet exception

Since:

0.7.2

fromDoubles

public boolean fromDoubles(double[] doubles)
                    throws JavetException

From double array.

Parameters:

doubles - the double array

Returns:

the boolean

Throws:

JavetException - the javet exception

Since:

0.7.2

fromFloats

public boolean fromFloats(float[] floats)
                   throws JavetException

From float array.

Parameters:

floats - the float array

Returns:

the boolean

Throws:

JavetException - the javet exception

Since:

0.7.2

fromIntegers

public boolean fromIntegers(int[] integers)
                     throws JavetException

From integer array.

Parameters:

integers - the integer array

Returns:

the boolean

Throws:

JavetException - the javet exception

Since:

0.7.2

fromLongs

public boolean fromLongs(long[] longs)
                  throws JavetException

From long array.

Parameters:

longs - the long array

Returns:

the boolean

Throws:

JavetException - the javet exception

Since:

0.7.2

fromShorts

public boolean fromShorts(short[] shorts)
                   throws JavetException

From short array.

Parameters:

shorts - the short array

Returns:

the boolean

Throws:

JavetException - the javet exception

Since:

0.7.2

get

public <T extends V8Value> T get(java.lang.Object key)
                          throws JavetException

Description copied from interface: IV8ValueObject

Get property value by key object.

The return value must be consumed, otherwise memory leak may occur.

Specified by:

get in interface IV8ValueObject

Overrides:

get in class V8ValueObject

Type Parameters:

T - the type parameter

Parameters:

key - the property key

Returns:

the property value

Throws:

JavetException - the javet exception

getBuffer

@CheckReturnValue
public V8ValueArrayBuffer getBuffer()
                                                throws JavetException

Specified by:

getBuffer in interface IV8ValueTypedArray

Throws:

JavetException

getByteLength

public int getByteLength()
                  throws JavetException

Specified by:

getByteLength in interface IV8ValueTypedArray

Throws:

JavetException

getByteOffset

public int getByteOffset()
                  throws JavetException

Specified by:

getByteOffset in interface IV8ValueTypedArray

Throws:

JavetException

getLength

public int getLength()
              throws JavetException

Specified by:

getLength in interface IV8ValueTypedArray

Throws:

JavetException

getSizeInBytes

public int getSizeInBytes()

Specified by:

getSizeInBytes in interface IV8ValueTypedArray

getType

public V8ValueReferenceType getType()

Specified by:

getType in interface IV8ValueReference

Overrides:

getType in class V8ValueObject

isValid

public boolean isValid()

Specified by:

isValid in interface IV8ValueTypedArray

setType

protected void setType(V8ValueReferenceType type)

Sets type.

Parameters:

type - the type

Since:

0.9.1

toBytes

public byte[] toBytes()
               throws JavetException

To byte array.

Returns:

the byte array

Throws:

JavetException - the javet exception

Since:

0.7.2

toDoubles

public double[] toDoubles()
                   throws JavetException

To double array.

Returns:

the double array

Throws:

JavetException - the javet exception

Since:

0.7.2

toFloats

public float[] toFloats()
                 throws JavetException

To float array.

Returns:

the float array

Throws:

JavetException - the javet exception

Since:

0.7.2

toIntegers

public int[] toIntegers()
                 throws JavetException

To int array.

Returns:

the int array

Throws:

JavetException - the javet exception

Since:

0.7.2

toLongs

public long[] toLongs()
               throws JavetException

To long array.

Returns:

the long array

Throws:

JavetException - the javet exception

Since:

0.7.2

toShorts

public short[] toShorts()
                 throws JavetException

To short array.

Returns:

the short array

Throws:

JavetException - the javet exception

Since:

0.7.2