com.caoccao.javet.values.reference

Interface IV8ValueArray

All Superinterfaces:

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

All Known Implementing Classes:

V8ValueArguments, V8ValueArray

public interface IV8ValueArray
extends IV8ValueObject

The interface V8 value array.

Since:

0.7.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FUNCTION_FLAT The constant FUNCTION_FLAT.
static java.lang.String	FUNCTION_POP The constant FUNCTION_POP.
static java.lang.String	FUNCTION_PUSH The constant FUNCTION_PUSH.
static java.lang.String	FUNCTION_SHIFT The constant FUNCTION_SHIFT.
static java.lang.String	FUNCTION_UNSHIFT The constant FUNCTION_UNSHIFT.

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

DEFAULT_BATCH_SIZE, MIN_BATCH_SIZE

Method Summary

Modifier and Type	Method and Description
default <T extends V8Value> T[]	batchGet() Batch get all the items from the array.
int	batchGet(V8Value[] v8Values, int startIndex, int endIndex) Batch get the given range of items from the array.
default IV8ValueArray	flat() Array.prototype.flat().
default IV8ValueArray	flat(int depth) Array.prototype.flat().
<Value extends V8Value,E extends java.lang.Throwable> int	forEach(IJavetUniConsumer<Value,E> consumer, int batchSize) For each of the item, call the consumer and return the item count.
<Value extends V8Value,E extends java.lang.Throwable> int	forEach(IJavetUniIndexedConsumer<Value,E> consumer, int batchSize) For each of the item, call the consumer and return the item count.
<T extends V8Value> T	get(int index) Get V8 value by index.
java.util.List<java.lang.Integer>	getKeys() Gets keys.
int	getLength() Gets length.
default <T extends V8Value> T	pop() Array.prototype.pop().
default java.math.BigInteger	popBigInteger() Pop big integer from the array.
default java.lang.Boolean	popBoolean() Pop boolean from the array.
default java.lang.Double	popDouble() Pop double from the array.
default java.lang.Integer	popInteger() Pop integer from the array.
default java.lang.Long	popLong() Pop long from the array.
default V8ValueNull	popNull() Pop V8 value null.
default <T> T	popObject() Pop object from the array.
default <R,T extends V8ValuePrimitive<R>> R	popPrimitive() Pop primitive from the array.
default java.lang.String	popString() Pop string from the array.
default V8ValueUndefined	popUndefined() Pop V8 value undefined.
default java.time.ZonedDateTime	popZonedDateTime() Pop zoned date time from the array.
default int	push(java.lang.Object... objects) Array.prototype.push().
default int	pushNull() Push null to the array.
default int	pushUndefined() Push undefined to the array.
default <T extends V8Value> T	shift() Array.prototype.shift().
default java.math.BigInteger	shiftBigInteger() Shift big integer from the array.
default java.lang.Boolean	shiftBoolean() Shift boolean from the array.
default java.lang.Double	shiftDouble() Shift double from the array.
default java.lang.Integer	shiftInteger() Shift integer from the array.
default java.lang.Long	shiftLong() Shift long from the array.
default V8ValueNull	shiftNull() Shift V8 value null.
default <T> T	shiftObject() Shift object from the array.
default <R,T extends V8ValuePrimitive<R>> R	shiftPrimitive() Shift primitive from the array.
default java.lang.String	shiftString() Shift string from the array.
default V8ValueUndefined	shiftUndefined() Shift V8 value undefined.
default java.time.ZonedDateTime	shiftZonedDateTime() Shift zoned date time from the array.
default V8Value[]	toArray() To V8 value array.
default int	unshift(java.lang.Object... objects) Array.prototype.unshift().
default int	unshiftNull() Unshift null to the array.
default int	unshiftUndefined() Unshift undefined to the array.

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, get, 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, getType, 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

FUNCTION_FLAT

static final java.lang.String FUNCTION_FLAT

The constant FUNCTION_FLAT.

Since:

3.0.4

See Also:

Constant Field Values

FUNCTION_SHIFT

static final java.lang.String FUNCTION_SHIFT

The constant FUNCTION_SHIFT.

Since:

3.0.4

See Also:

Constant Field Values

FUNCTION_UNSHIFT

static final java.lang.String FUNCTION_UNSHIFT

The constant FUNCTION_UNSHIFT.

Since:

3.0.4

See Also:

Constant Field Values

FUNCTION_POP

static final java.lang.String FUNCTION_POP

The constant FUNCTION_POP.

Since:

3.0.4

See Also:

Constant Field Values

FUNCTION_PUSH

static final java.lang.String FUNCTION_PUSH

The constant FUNCTION_PUSH.

Since:

3.0.4

See Also:

Constant Field Values

Method Detail

batchGet

int batchGet(V8Value[] v8Values,
             int startIndex,
             int endIndex)
      throws JavetException

Batch get the given range of items from the array.

Parameters:

v8Values - the V8 values

startIndex - the start index

endIndex - the end index

Returns:

the actual item count

Throws:

JavetException - the javet exception

Since:

2.2.0

batchGet

default <T extends V8Value> T[] batchGet()
                                  throws JavetException

Batch get all the items from the array.

Type Parameters:

T - the type parameter

Returns:

the V8 values

Throws:

JavetException - the javet exception

Since:

2.2.0

flat

@CheckReturnValue
default IV8ValueArray flat()
                                       throws JavetException

Array.prototype.flat(). The flat() method of Array instances creates a new array with all sub-array elements concatenated into it recursively up to the default depth 1.

Returns:

the V8 value array

Throws:

JavetException - the javet exception

Since:

3.0.4

flat

@CheckReturnValue
default IV8ValueArray flat(int depth)
                                       throws JavetException

Array.prototype.flat(). The flat() method of Array instances creates a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Parameters:

depth - the depth level specifying how deep a nested array structure should be flattened. Defaults to 1.

Returns:

the V8 value array

Throws:

JavetException - the javet exception

Since:

3.0.4

forEach

<Value extends V8Value,E extends java.lang.Throwable> int forEach(IJavetUniConsumer<Value,E> consumer,
                                                                  int batchSize)
                                                           throws JavetException,
                                                                  E extends java.lang.Throwable

For each of the item, call the consumer and return the item count.

Specified by:

forEach in interface IV8ValueObject

Type Parameters:

Value - the type parameter

E - the type parameter

Parameters:

consumer - the consumer

batchSize - the batch size

Returns:

the item count

Throws:

JavetException - the javet exception

E - the custom exception

E extends java.lang.Throwable

Since:

2.2.0

forEach

<Value extends V8Value,E extends java.lang.Throwable> int forEach(IJavetUniIndexedConsumer<Value,E> consumer,
                                                                  int batchSize)
                                                           throws JavetException,
                                                                  E extends java.lang.Throwable

For each of the item, call the consumer and return the item count.

Specified by:

forEach in interface IV8ValueObject

Type Parameters:

Value - the type parameter

E - the type parameter

Parameters:

consumer - the consumer

batchSize - the batch size

Returns:

the item count

Throws:

JavetException - the javet exception

E - the custom exception

E extends java.lang.Throwable

Since:

2.2.0

get

@CheckReturnValue
<T extends V8Value> T get(int index)
                                      throws JavetException

Get V8 value by index.

Type Parameters:

T - the type parameter

Parameters:

index - the index

Returns:

the V8 value

Throws:

JavetException - the javet exception

Since:

0.7.0

getKeys

java.util.List<java.lang.Integer> getKeys()
                                   throws JavetException

Gets keys.

Returns:

the keys

Throws:

JavetException - the javet exception

Since:

0.7.2

getLength

int getLength()
       throws JavetException

Gets length.

Returns:

the length

Throws:

JavetException - the javet exception

Since:

0.7.0

pop

@CheckReturnValue
default <T extends V8Value> T pop()
                                              throws JavetException

Array.prototype.pop(). The pop() method of Array instances removes the last element from an array and returns that element. This method changes the length of the array.

Type Parameters:

T - the type parameter

Returns:

the V8 value

Throws:

JavetException - the javet exception

Since:

0.7.0

popBigInteger

default java.math.BigInteger popBigInteger()
                                    throws JavetException

Pop big integer from the array.

Returns:

the big integer

Throws:

JavetException - the javet exception

Since:

1.1.5

popBoolean

default java.lang.Boolean popBoolean()
                              throws JavetException

Pop boolean from the array.

Returns:

the boolean

Throws:

JavetException - the javet exception

Since:

0.7.0

popDouble

default java.lang.Double popDouble()
                            throws JavetException

Pop double from the array.

Returns:

the double

Throws:

JavetException - the javet exception

Since:

0.7.0

popInteger

default java.lang.Integer popInteger()
                              throws JavetException

Pop integer from the array.

Returns:

the integer

Throws:

JavetException - the javet exception

Since:

0.7.0

popLong

default java.lang.Long popLong()
                        throws JavetException

Pop long from the array.

Returns:

the long

Throws:

JavetException - the javet exception

Since:

0.7.0

popNull

default V8ValueNull popNull()
                     throws JavetException

Pop V8 value null.

Returns:

the V8 value null

Throws:

JavetException - the javet exception

Since:

0.7.0

popObject

default <T> T popObject()
                 throws JavetException

Pop object from the array.

Type Parameters:

T - the type parameter

Returns:

the object

Throws:

JavetException - the javet exception

Since:

0.8.10

popPrimitive

default <R,T extends V8ValuePrimitive<R>> R popPrimitive()
                                                  throws JavetException

Pop primitive from the array.

Type Parameters:

R - the type parameter

T - the type parameter

Returns:

the V8 value primitive

Throws:

JavetException - the javet exception

Since:

0.8.10

popString

default java.lang.String popString()
                            throws JavetException

Pop string from the array.

Returns:

the string

Throws:

JavetException - the javet exception

Since:

0.7.0

popUndefined

default V8ValueUndefined popUndefined()
                               throws JavetException

Pop V8 value undefined.

Returns:

the V8 value undefined

Throws:

JavetException - the javet exception

Since:

0.7.0

popZonedDateTime

default java.time.ZonedDateTime popZonedDateTime()
                                          throws JavetException

Pop zoned date time from the array.

Returns:

the string

Throws:

JavetException - the javet exception

Since:

3.0.4

push

default int push(java.lang.Object... objects)
          throws JavetException

Array.prototype.push(). The push() method of Array instances adds the specified elements to the end of an array and returns the new length of the array.

Parameters:

objects - the objects

Returns:

the array length

Throws:

JavetException - the javet exception

Since:

0.7.0

pushNull

default int pushNull()
              throws JavetException

Push null to the array.

Returns:

the array length

Throws:

JavetException - the javet exception

Since:

0.7.0

pushUndefined

default int pushUndefined()
                   throws JavetException

Push undefined to the array.

Returns:

the array length

Throws:

JavetException - the javet exception

Since:

0.7.2

shift

@CheckReturnValue
default <T extends V8Value> T shift()
                                                throws JavetException

Array.prototype.shift(). The shift() method of Array instances removes the first element from an array and returns that removed element. This method changes the length of the array.

Type Parameters:

T - the type parameter

Returns:

the V8 value

Throws:

JavetException - the javet exception

Since:

3.0.4

shiftBigInteger

default java.math.BigInteger shiftBigInteger()
                                      throws JavetException

Shift big integer from the array.

Returns:

the big integer

Throws:

JavetException - the javet exception

Since:

3.0.4

shiftBoolean

default java.lang.Boolean shiftBoolean()
                                throws JavetException

Shift boolean from the array.

Returns:

the boolean

Throws:

JavetException - the javet exception

Since:

3.0.4

shiftDouble

default java.lang.Double shiftDouble()
                              throws JavetException

Shift double from the array.

Returns:

the double

Throws:

JavetException - the javet exception

Since:

3.0.4

shiftInteger

default java.lang.Integer shiftInteger()
                                throws JavetException

Shift integer from the array.

Returns:

the integer

Throws:

JavetException - the javet exception

Since:

3.0.4

shiftLong

default java.lang.Long shiftLong()
                          throws JavetException

Shift long from the array.

Returns:

the long

Throws:

JavetException - the javet exception

Since:

3.0.4

shiftNull

default V8ValueNull shiftNull()
                       throws JavetException

Shift V8 value null.

Returns:

the V8 value null

Throws:

JavetException - the javet exception

Since:

3.0.4

shiftObject

default <T> T shiftObject()
                   throws JavetException

Shift object from the array.

Type Parameters:

T - the type parameter

Returns:

the object

Throws:

JavetException - the javet exception

Since:

3.0.4

shiftPrimitive

default <R,T extends V8ValuePrimitive<R>> R shiftPrimitive()
                                                    throws JavetException

Shift primitive from the array.

Type Parameters:

R - the type parameter

T - the type parameter

Returns:

the V8 value primitive

Throws:

JavetException - the javet exception

Since:

3.0.4

shiftString

default java.lang.String shiftString()
                              throws JavetException

Shift string from the array.

Returns:

the string

Throws:

JavetException - the javet exception

Since:

3.0.4

shiftUndefined

default V8ValueUndefined shiftUndefined()
                                 throws JavetException

Shift V8 value undefined.

Returns:

the V8 value undefined

Throws:

JavetException - the javet exception

Since:

3.0.4

shiftZonedDateTime

default java.time.ZonedDateTime shiftZonedDateTime()
                                            throws JavetException

Shift zoned date time from the array.

Returns:

the string

Throws:

JavetException - the javet exception

Since:

3.0.4

toArray

@CheckReturnValue
default V8Value[] toArray()
                                      throws JavetException

To V8 value array.

Returns:

the V8 value array

Throws:

JavetException - the javet exception

Since:

0.9.10

unshift

default int unshift(java.lang.Object... objects)
             throws JavetException

Array.prototype.unshift(). The unshift() method of Array instances adds the specified elements to the beginning of an array and returns the new length of the array.

Parameters:

objects - the objects

Returns:

the array length

Throws:

JavetException - the javet exception

Since:

3.0.4

unshiftNull

default int unshiftNull()
                 throws JavetException

Unshift null to the array.

Returns:

the array length

Throws:

JavetException - the javet exception

Since:

3.0.4

unshiftUndefined

default int unshiftUndefined()
                      throws JavetException

Unshift undefined to the array.

Returns:

the array length

Throws:

JavetException - the javet exception

Since:

3.0.4