com.caoccao.javet.values.reference

Interface IV8Module

All Superinterfaces:

java.lang.AutoCloseable, IJavetClosable, IV8Cacheable, IV8Cloneable, IV8Convertible, IV8Executable, IV8Value, IV8ValueNonProxyable, IV8ValueReference

All Known Implementing Classes:

V8Module

public interface IV8Module
extends IV8Cacheable, IV8ValueReference, IV8Executable, IV8ValueNonProxyable

The interface IV8Module.

Since:

0.8.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	Errored The constant Errored.
static int	Evaluated The constant Evaluated.
static int	Evaluating The constant Evaluating.
static int	Instantiated The constant Instantiated.
static int	Instantiating The constant Instantiating.
static int	Uninstantiated The constant Uninstantiated.

Method Summary

Modifier and Type	Method and Description
default <T extends V8Value> T	evaluate() Evaluate the module.
<T extends V8Value> T	evaluate(boolean resultRequired) Evaluate the module.
default <T extends V8Value> T	execute(boolean resultRequired) Execute and return V8 value if required.
V8ValueError	getException() Gets exception.
int	getIdentityHash() Returns the identity hash for this object.
V8Value	getNamespace() Gets namespace.
java.lang.String	getResourceName() Gets resource name.
int	getScriptId() Gets script id.
int	getStatus() Gets status.
boolean	instantiate() Instantiate.
boolean	isSourceTextModule() Is source text module.
boolean	isSyntheticModule() Is synthetic module.
default <T,V extends V8Value> T	toObject(V v8Value) Convert from V8 value to object.
default <T,V extends V8Value> V	toV8Value(T object) Convert object to V8 value.

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

getCachedData

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

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

execute, executeBigInteger, executeBoolean, executeDouble, executeInteger, executeLong, executeObject, executeString, executeVoid, executeZonedDateTime

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

toObject

Field Detail

Uninstantiated

static final int Uninstantiated

The constant Uninstantiated.

Since:

0.8.0

See Also:

Constant Field Values

Instantiating

static final int Instantiating

The constant Instantiating.

Since:

0.8.0

See Also:

Constant Field Values

Instantiated

static final int Instantiated

The constant Instantiated.

Since:

0.8.0

See Also:

Constant Field Values

Evaluating

static final int Evaluating

The constant Evaluating.

Since:

0.8.0

See Also:

Constant Field Values

Evaluated

static final int Evaluated

The constant Evaluated.

Since:

0.8.0

See Also:

Constant Field Values

Errored

static final int Errored

The constant Errored.

Since:

0.8.0

See Also:

Constant Field Values

Method Detail

evaluate

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

Evaluate the module.

Type Parameters:

T - the type parameter

Returns:

the t

Throws:

JavetException - the javet exception

Since:

0.8.0

evaluate

@CheckReturnValue
<T extends V8Value> T evaluate(boolean resultRequired)
                                          throws JavetException

Evaluate the module.

Type Parameters:

T - the type parameter

Parameters:

resultRequired - the result required

Returns:

the t

Throws:

JavetException - the javet exception

Since:

0.8.0

execute

@CheckReturnValue
default <T extends V8Value> T execute(boolean resultRequired)
                                                 throws JavetException

Description copied from interface: IV8Executable

Execute and return V8 value if required.

Specified by:

execute in interface IV8Executable

Type Parameters:

T - the type parameter

Parameters:

resultRequired - the result required

Returns:

the V8 value

Throws:

JavetException - the javet exception

getException

@CheckReturnValue
V8ValueError getException()
                                     throws JavetException

Gets exception.

Returns:

the exception

Throws:

JavetException - the javet exception

Since:

0.8.0

getIdentityHash

int getIdentityHash()
             throws JavetException

Returns the identity hash for this object. The current implementation uses an inline property on the object to store the identity hash.

The return value will never be 0. Also, it is not guaranteed to be unique.

Returns:

the identity hash

Throws:

JavetException - the javet exception

Since:

3.1.0

getNamespace

@CheckReturnValue
V8Value getNamespace()
                                throws JavetException

Gets namespace.

The module's status must be at least kInstantiated. Otherwise, undefined is returned.

Returns:

the namespace

Throws:

JavetException - the javet exception

Since:

0.8.0

getResourceName

java.lang.String getResourceName()
                          throws JavetException

Gets resource name.

Returns:

the resource name

Throws:

JavetException - the javet exception

Since:

0.8.0

getScriptId

int getScriptId()
         throws JavetException

Gets script id.

The module must be a SourceTextModule and must not have a kErrored status. Otherwise, -1 is returned.

Returns:

the script id

Throws:

JavetException - the javet exception

Since:

0.8.0

getStatus

int getStatus()
       throws JavetException

Gets status.

Returns:

the status

Throws:

JavetException - the javet exception

Since:

0.8.0

instantiate

boolean instantiate()
             throws JavetException

Instantiate.

Returns:

true : instantiated, false : not instantiated

Throws:

JavetException - the javet exception

Since:

0.8.0

isSourceTextModule

boolean isSourceTextModule()
                    throws JavetException

Is source text module.

Returns:

true : yes, false : no

Throws:

JavetException - the javet exception

Since:

3.0.1

isSyntheticModule

boolean isSyntheticModule()
                   throws JavetException

Is synthetic module.

Returns:

true : yes, false : no

Throws:

JavetException - the javet exception

Since:

3.0.1

toObject

default <T,V extends V8Value> T toObject(V v8Value)
                                  throws JavetException

Description copied from interface: IV8Convertible

Convert from V8 value to object. The caller is responsible for closing the V8 value.

Specified by:

toObject in interface IV8Convertible

Type Parameters:

T - the type parameter

V - the type parameter

Parameters:

v8Value - the V8 value

Returns:

the object

Throws:

JavetException - the javet exception

toV8Value

@CheckReturnValue
default <T,V extends V8Value> V toV8Value(T object)
                                                     throws JavetException

Description copied from interface: IV8Convertible

Convert object to V8 value.

Specified by:

toV8Value in interface IV8Convertible

Type Parameters:

T - the type parameter

V - the type parameter

Parameters:

object - the object

Returns:

the V8 value

Throws:

JavetException - the javet exception