com.caoccao.javet.interop

Class V8Scope

java.lang.Object

com.caoccao.javet.interop.V8Scope

All Implemented Interfaces:

IJavetClosable, IV8Creatable, java.lang.AutoCloseable

public class V8Scope
extends java.lang.Object
implements IV8Creatable, IJavetClosable

The type V8 scope is for preventing memory leak when exception is thrown. It needs to be used by try-with-resource. By default, escapable is set to false so that the internal value can be close when exception is thrown. If there is no exception, escapable needs to be set to true before try-with-resource is closed.

Usage 1 without V8 runtime

 try (V8Scope v8Scope = new V8Scope()) {
     V8ValueObject v8ValueObject = v8Scope.add(v8Runtime.createV8ValueObject());
     // v8ValueObject will be closed automatically if there is an exception thrown.
     v8Scope.setEscapable();
     // v8ValueObject will not be closed.
     return v8ValueObject;
 }
 

Usage 2 with V8 runtime

 try (V8Scope v8Scope = v8Runtime.getV8Scope()) {
     V8ValueObject v8ValueObject = v8Scope.createV8ValueObject();
     // v8ValueObject will be closed automatically if there is an exception thrown.
     v8Scope.setEscapable();
     // v8ValueObject will not be closed.
     return v8ValueObject;
 }
 

Since:

0.9.13

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	closed The Closed.
protected static java.lang.String	ERROR_MESSAGE_V8_RUNTIME_CANNOT_BE_EMPTY The constant ERROR_MESSAGE_V8_RUNTIME_CANNOT_BE_EMPTY.
protected boolean	escapable The Escapable.
protected V8Runtime	v8Runtime The V8 runtime.
protected java.util.List<V8Value>	values The Values.

Constructor Summary

Constructors

Constructor and Description
V8Scope() Instantiates a new V8 scope.

Method Summary

Modifier and Type	Method and Description
<T extends V8Value> T	add(T value) Add a value.
void	close()
V8Module	createV8Module(java.lang.String moduleName, IV8ValueObject iV8ValueObject) Create a V8 synthetic module.
V8ValueArray	createV8ValueArray() Create V8 value array.
V8ValueArrayBuffer	createV8ValueArrayBuffer(java.nio.ByteBuffer byteBuffer) Create V8 value array buffer from a native byte buffer.
V8ValueArrayBuffer	createV8ValueArrayBuffer(int length) Create V8 value array buffer from a given length.
V8ValueBigInteger	createV8ValueBigInteger(java.math.BigInteger bigInteger) Create V8 value big integer.
V8ValueBigInteger	createV8ValueBigInteger(java.lang.String bigIntegerValue) Create V8 value big integer.
V8ValueBoolean	createV8ValueBoolean(boolean booleanValue) Create V8 value boolean.
V8ValueBooleanObject	createV8ValueBooleanObject(boolean booleanValue) Create V8 value boolean object.
V8ValueDataView	createV8ValueDataView(V8ValueArrayBuffer v8ValueArrayBuffer) Create V8 value data view.
V8ValueDouble	createV8ValueDouble(double doubleValue) Create V8 value double.
V8ValueDoubleObject	createV8ValueDoubleObject(double doubleValue) Create V8 value double object.
V8ValueError	createV8ValueError(V8ValueErrorType v8ValueErrorType, java.lang.String message) Create V8 value error by type and message.
V8ValueFunction	createV8ValueFunction(JavetCallbackContext javetCallbackContext) Create V8 value function.
V8ValueFunction	createV8ValueFunction(java.lang.String codeString) Create V8 value function.
V8ValueInteger	createV8ValueInteger(int integerValue) Create V8 value integer.
V8ValueIntegerObject	createV8ValueIntegerObject(int intValue) Create V8 value int object.
V8ValueLong	createV8ValueLong(long longValue) Create V8 value long.
V8ValueLongObject	createV8ValueLongObject(long longValue) Create V8 value long object.
V8ValueMap	createV8ValueMap() Create V8 value map.
V8ValueNull	createV8ValueNull() Create V8 value null.
V8ValueObject	createV8ValueObject() Create V8 value object.
V8ValuePromise	createV8ValuePromise() Create V8 value promise.
V8ValueProxy	createV8ValueProxy(V8Value v8Value) Create V8 value proxy.
V8ValueSet	createV8ValueSet() Create V8 value set.
V8ValueString	createV8ValueString(java.lang.String str) Create V8 value string.
V8ValueStringObject	createV8ValueStringObject(java.lang.String str) Create V8 value string object from string.
V8ValueSymbol	createV8ValueSymbol(java.lang.String description, boolean global) Create V8 value symbol.
V8ValueTypedArray	createV8ValueTypedArray(V8ValueReferenceType type, int length) Create V8 value typed array.
V8ValueUndefined	createV8ValueUndefined() Create V8 value undefined.
V8ValueZonedDateTime	createV8ValueZonedDateTime(long jsTimestamp) Create V8 value zoned date time.
V8ValueZonedDateTime	createV8ValueZonedDateTime(java.time.ZonedDateTime zonedDateTime) Create V8 value zoned date time.
<T extends V8Value> T	get(int index) Gets a value by index.
boolean	isClosed() Is closed.
boolean	isEscapable() Is escapable.
V8Scope	setEscapable() Sets escapable to true.
V8Scope	setEscapable(boolean escapable) Sets escapable.

Methods inherited from class java.lang.Object

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

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

createV8ValueProxy, createV8ValueSymbol

Field Detail

ERROR_MESSAGE_V8_RUNTIME_CANNOT_BE_EMPTY

protected static final java.lang.String ERROR_MESSAGE_V8_RUNTIME_CANNOT_BE_EMPTY

The constant ERROR_MESSAGE_V8_RUNTIME_CANNOT_BE_EMPTY.

Since:

0.9.14

See Also:

Constant Field Values

closed

protected boolean closed

The Closed.

Since:

0.9.13

escapable

protected boolean escapable

The Escapable.

Since:

0.9.13

v8Runtime

protected V8Runtime v8Runtime

The V8 runtime.

Since:

0.9.14

values

protected java.util.List<V8Value> values

The Values.

Since:

0.9.14

Constructor Detail

V8Scope

public V8Scope()

Instantiates a new V8 scope.

Since:

0.9.13

Method Detail

add

public <T extends V8Value> T add(T value)

Add a value.

Type Parameters:

T - the type parameter

Parameters:

value - the value

Returns:

the value

Since:

0.9.14

close

public void close()
           throws JavetException

Specified by:

close in interface IJavetClosable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

JavetException

createV8Module

public V8Module createV8Module(java.lang.String moduleName,
                               IV8ValueObject iV8ValueObject)
                        throws JavetException

Description copied from interface: IV8Creatable

Create a V8 synthetic module.

Specified by:

createV8Module in interface IV8Creatable

Parameters:

moduleName - the module name

iV8ValueObject - the V8 value object to be exported

Returns:

the V8 module

Throws:

JavetException - the javet exception

createV8ValueArray

public V8ValueArray createV8ValueArray()
                                throws JavetException

Description copied from interface: IV8Creatable

Create V8 value array.

Specified by:

createV8ValueArray in interface IV8Creatable

Returns:

the V8 value array

Throws:

JavetException - the javet exception

createV8ValueArrayBuffer

public V8ValueArrayBuffer createV8ValueArrayBuffer(int length)
                                            throws JavetException

Description copied from interface: IV8Creatable

Create V8 value array buffer from a given length.

Specified by:

createV8ValueArrayBuffer in interface IV8Creatable

Parameters:

length - the length

Returns:

the V8 value array buffer

Throws:

JavetException - the javet exception

createV8ValueArrayBuffer

public V8ValueArrayBuffer createV8ValueArrayBuffer(java.nio.ByteBuffer byteBuffer)
                                            throws JavetException

Description copied from interface: IV8Creatable

Create V8 value array buffer from a native byte buffer.

Specified by:

createV8ValueArrayBuffer in interface IV8Creatable

Parameters:

byteBuffer - the byte buffer

Returns:

the V8 value array buffer

Throws:

JavetException - the javet exception

createV8ValueBigInteger

public V8ValueBigInteger createV8ValueBigInteger(java.math.BigInteger bigInteger)
                                          throws JavetException

Description copied from interface: IV8Creatable

Create V8 value big integer.

Specified by:

createV8ValueBigInteger in interface IV8Creatable

Parameters:

bigInteger - the big integer

Returns:

the V8 value big integer

Throws:

JavetException - the javet exception

createV8ValueBigInteger

public V8ValueBigInteger createV8ValueBigInteger(java.lang.String bigIntegerValue)
                                          throws JavetException

Description copied from interface: IV8Creatable

Create V8 value big integer.

Specified by:

createV8ValueBigInteger in interface IV8Creatable

Parameters:

bigIntegerValue - the big integer value

Returns:

the V8 value big integer

Throws:

JavetException - the javet exception

createV8ValueBoolean

public V8ValueBoolean createV8ValueBoolean(boolean booleanValue)
                                    throws JavetException

Description copied from interface: IV8Creatable

Create V8 value boolean.

Specified by:

createV8ValueBoolean in interface IV8Creatable

Parameters:

booleanValue - the boolean value

Returns:

the V8 value boolean

Throws:

JavetException - the javet exception

createV8ValueBooleanObject

public V8ValueBooleanObject createV8ValueBooleanObject(boolean booleanValue)
                                                throws JavetException

Description copied from interface: IV8Creatable

Create V8 value boolean object.

Specified by:

createV8ValueBooleanObject in interface IV8Creatable

Parameters:

booleanValue - the boolean value

Returns:

the V8 value boolean object

Throws:

JavetException - the javet exception

createV8ValueDataView

public V8ValueDataView createV8ValueDataView(V8ValueArrayBuffer v8ValueArrayBuffer)
                                      throws JavetException

Description copied from interface: IV8Creatable

Create V8 value data view.

Specified by:

createV8ValueDataView in interface IV8Creatable

Parameters:

v8ValueArrayBuffer - the V8 value array buffer

Returns:

the V8 value data view

Throws:

JavetException - the javet exception

createV8ValueDouble

public V8ValueDouble createV8ValueDouble(double doubleValue)
                                  throws JavetException

Description copied from interface: IV8Creatable

Create V8 value double.

Specified by:

createV8ValueDouble in interface IV8Creatable

Parameters:

doubleValue - the double value

Returns:

the V8 value double

Throws:

JavetException - the javet exception

createV8ValueDoubleObject

public V8ValueDoubleObject createV8ValueDoubleObject(double doubleValue)
                                              throws JavetException

Description copied from interface: IV8Creatable

Create V8 value double object.

Specified by:

createV8ValueDoubleObject in interface IV8Creatable

Parameters:

doubleValue - the double value

Returns:

the V8 value double object

Throws:

JavetException - the javet exception

createV8ValueError

public V8ValueError createV8ValueError(V8ValueErrorType v8ValueErrorType,
                                       java.lang.String message)
                                throws JavetException

Description copied from interface: IV8Creatable

Create V8 value error by type and message.

Specified by:

createV8ValueError in interface IV8Creatable

Parameters:

v8ValueErrorType - the V8 value error type

message - the message

Returns:

the V8 value error

Throws:

JavetException - the javet exception

createV8ValueFunction

public V8ValueFunction createV8ValueFunction(JavetCallbackContext javetCallbackContext)
                                      throws JavetException

Description copied from interface: IV8Creatable

Create V8 value function.

Specified by:

createV8ValueFunction in interface IV8Creatable

Parameters:

javetCallbackContext - the javet callback context

Returns:

the V8 value function

Throws:

JavetException - the javet exception

createV8ValueFunction

public V8ValueFunction createV8ValueFunction(java.lang.String codeString)
                                      throws JavetException

Description copied from interface: IV8Creatable

Create V8 value function.

Specified by:

createV8ValueFunction in interface IV8Creatable

Parameters:

codeString - the code string

Returns:

the V8 value function

Throws:

JavetException - the javet exception

createV8ValueInteger

public V8ValueInteger createV8ValueInteger(int integerValue)
                                    throws JavetException

Description copied from interface: IV8Creatable

Create V8 value integer.

Specified by:

createV8ValueInteger in interface IV8Creatable

Parameters:

integerValue - the integer value

Returns:

the V8 value integer

Throws:

JavetException - the javet exception

createV8ValueIntegerObject

public V8ValueIntegerObject createV8ValueIntegerObject(int intValue)
                                                throws JavetException

Description copied from interface: IV8Creatable

Create V8 value int object.

Specified by:

createV8ValueIntegerObject in interface IV8Creatable

Parameters:

intValue - the int value

Returns:

the V8 value integer object

Throws:

JavetException - the javet exception

createV8ValueLong

public V8ValueLong createV8ValueLong(long longValue)
                              throws JavetException

Description copied from interface: IV8Creatable

Create V8 value long.

Specified by:

createV8ValueLong in interface IV8Creatable

Parameters:

longValue - the long value

Returns:

the V8 value long

Throws:

JavetException - the javet exception

createV8ValueLongObject

public V8ValueLongObject createV8ValueLongObject(long longValue)
                                          throws JavetException

Description copied from interface: IV8Creatable

Create V8 value long object.

Specified by:

createV8ValueLongObject in interface IV8Creatable

Parameters:

longValue - the long value

Returns:

the V8 value long object

Throws:

JavetException - the javet exception

createV8ValueMap

public V8ValueMap createV8ValueMap()
                            throws JavetException

Description copied from interface: IV8Creatable

Create V8 value map.

Specified by:

createV8ValueMap in interface IV8Creatable

Returns:

the V8 value map

Throws:

JavetException - the javet exception

createV8ValueNull

public V8ValueNull createV8ValueNull()

Description copied from interface: IV8Creatable

Create V8 value null.

Specified by:

createV8ValueNull in interface IV8Creatable

Returns:

the V8 value null

createV8ValueObject

public V8ValueObject createV8ValueObject()
                                  throws JavetException

Description copied from interface: IV8Creatable

Create V8 value object.

Specified by:

createV8ValueObject in interface IV8Creatable

Returns:

the V8 value object

Throws:

JavetException - the javet exception

createV8ValuePromise

public V8ValuePromise createV8ValuePromise()
                                    throws JavetException

Description copied from interface: IV8Creatable

Create V8 value promise.

Specified by:

createV8ValuePromise in interface IV8Creatable

Returns:

the V8 value promise

Throws:

JavetException - the javet exception

createV8ValueProxy

public V8ValueProxy createV8ValueProxy(V8Value v8Value)
                                throws JavetException

Description copied from interface: IV8Creatable

Create V8 value proxy.

Specified by:

createV8ValueProxy in interface IV8Creatable

Parameters:

v8Value - the V8 value

Returns:

the V8 value proxy

Throws:

JavetException - the javet exception

createV8ValueSet

public V8ValueSet createV8ValueSet()
                            throws JavetException

Description copied from interface: IV8Creatable

Create V8 value set.

Specified by:

createV8ValueSet in interface IV8Creatable

Returns:

the V8 value set

Throws:

JavetException - the javet exception

createV8ValueString

public V8ValueString createV8ValueString(java.lang.String str)
                                  throws JavetException

Description copied from interface: IV8Creatable

Create V8 value string.

Specified by:

createV8ValueString in interface IV8Creatable

Parameters:

str - the str

Returns:

the V8 value string

Throws:

JavetException - the javet exception

createV8ValueStringObject

public V8ValueStringObject createV8ValueStringObject(java.lang.String str)
                                              throws JavetException

Description copied from interface: IV8Creatable

Create V8 value string object from string.

Specified by:

createV8ValueStringObject in interface IV8Creatable

Parameters:

str - the str

Returns:

the V8 value string object

Throws:

JavetException - the javet exception

createV8ValueSymbol

public V8ValueSymbol createV8ValueSymbol(java.lang.String description,
                                         boolean global)
                                  throws JavetException

Description copied from interface: IV8Creatable

Create V8 value symbol.

Specified by:

createV8ValueSymbol in interface IV8Creatable

Parameters:

description - the description

global - the global

Returns:

the V8 value symbol

Throws:

JavetException - the javet exception

createV8ValueTypedArray

public V8ValueTypedArray createV8ValueTypedArray(V8ValueReferenceType type,
                                                 int length)
                                          throws JavetException

Description copied from interface: IV8Creatable

Create V8 value typed array.

Specified by:

createV8ValueTypedArray in interface IV8Creatable

Parameters:

type - the type

length - the length

Returns:

the V8 value typed array

Throws:

JavetException - the javet exception

createV8ValueUndefined

public V8ValueUndefined createV8ValueUndefined()

Description copied from interface: IV8Creatable

Create V8 value undefined.

Specified by:

createV8ValueUndefined in interface IV8Creatable

Returns:

the V8 value undefined

createV8ValueZonedDateTime

public V8ValueZonedDateTime createV8ValueZonedDateTime(long jsTimestamp)
                                                throws JavetException

Description copied from interface: IV8Creatable

Create V8 value zoned date time.

Specified by:

createV8ValueZonedDateTime in interface IV8Creatable

Parameters:

jsTimestamp - the js timestamp

Returns:

the V8 value zoned date time

Throws:

JavetException - the javet exception

createV8ValueZonedDateTime

public V8ValueZonedDateTime createV8ValueZonedDateTime(java.time.ZonedDateTime zonedDateTime)
                                                throws JavetException

Description copied from interface: IV8Creatable

Create V8 value zoned date time.

Specified by:

createV8ValueZonedDateTime in interface IV8Creatable

Parameters:

zonedDateTime - the zoned date time

Returns:

the V8 value zoned date time

Throws:

JavetException - the javet exception

get

public <T extends V8Value> T get(int index)

Gets a value by index.

Type Parameters:

T - the type parameter

Parameters:

index - the index

Returns:

the value

Since:

0.9.13

isClosed

public boolean isClosed()

Description copied from interface: IJavetClosable

Is closed.

Specified by:

isClosed in interface IJavetClosable

Returns:

true : closed, false: not closed

isEscapable

public boolean isEscapable()

Is escapable.

Returns:

the boolean

Since:

0.9.13

setEscapable

public V8Scope setEscapable()

Sets escapable to true.

Returns:

the self

Since:

0.9.13

setEscapable

public V8Scope setEscapable(boolean escapable)

Sets escapable.

Parameters:

escapable - the escapable

Returns:

the self

Since:

0.9.13