com.caoccao.javet.values.reference

Class V8Module

java.lang.Object

com.caoccao.javet.values.V8Data

com.caoccao.javet.values.V8Value

com.caoccao.javet.values.reference.V8ValueReference

com.caoccao.javet.values.reference.V8Module

All Implemented Interfaces:

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

public class V8Module
extends V8ValueReference
implements IV8Module

The type V8 module.

Since:

0.8.0

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	resourceName The Resource name.
protected java.lang.Boolean	sourceTextModule The source text module is an internal cache storing whether the module is source text or not.
protected java.lang.Boolean	syntheticModule The synthetic module is an internal cache storing whether the module is synthetic or not.

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.IV8Module

Errored, Evaluated, Evaluating, Instantiated, Instantiating, Uninstantiated

Method Summary

Modifier and Type	Method and Description
<T extends V8Value> T	evaluate(boolean resultRequired) Evaluate the module.
byte[]	getCachedData() Gets cached data.
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.
V8ValueReferenceType	getType()
boolean	instantiate() Instantiate.
boolean	isSourceTextModule() Is source text module.
boolean	isSyntheticModule() Is synthetic module.
V8Module	toClone(boolean referenceCopy) Get a clone of the current V8 value.
java.lang.String	toString()

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

addReference, checkV8Runtime, clearWeak, close, close, equals, getHandle, isClosed, isWeak, isWeak, removeReference, sameValue, setWeak, strictEquals

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.IV8Module

evaluate, execute, toObject, toV8Value

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

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

resourceName

protected java.lang.String resourceName

The Resource name.

Since:

0.8.0

sourceTextModule

protected java.lang.Boolean sourceTextModule

The source text module is an internal cache storing whether the module is source text or not.

Since:

3.0.1

syntheticModule

protected java.lang.Boolean syntheticModule

The synthetic module is an internal cache storing whether the module is synthetic or not.

Since:

3.0.1

Method Detail

evaluate

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

Description copied from interface: IV8Module

Evaluate the module.

Specified by:

evaluate in interface IV8Module

Type Parameters:

T - the type parameter

Parameters:

resultRequired - the result required

Returns:

the t

Throws:

JavetException - the javet exception

getCachedData

public byte[] getCachedData()
                     throws JavetException

Description copied from interface: IV8Cacheable

Gets cached data.

Specified by:

getCachedData in interface IV8Cacheable

Returns:

the cached data

Throws:

JavetException - the javet exception

getException

@CheckReturnValue
public V8ValueError getException()
                                             throws JavetException

Description copied from interface: IV8Module

Gets exception.

Specified by:

getException in interface IV8Module

Returns:

the exception

Throws:

JavetException - the javet exception

getIdentityHash

public int getIdentityHash()
                    throws JavetException

Description copied from interface: IV8Module

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.

Specified by:

getIdentityHash in interface IV8Module

Returns:

the identity hash

Throws:

JavetException - the javet exception

getNamespace

@CheckReturnValue
public V8Value getNamespace()
                                        throws JavetException

Description copied from interface: IV8Module

Gets namespace.

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

Specified by:

getNamespace in interface IV8Module

Returns:

the namespace

Throws:

JavetException - the javet exception

getResourceName

public java.lang.String getResourceName()
                                 throws JavetException

Description copied from interface: IV8Module

Gets resource name.

Specified by:

getResourceName in interface IV8Module

Returns:

the resource name

Throws:

JavetException - the javet exception

getScriptId

public int getScriptId()
                throws JavetException

Description copied from interface: IV8Module

Gets script id.

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

Specified by:

getScriptId in interface IV8Module

Returns:

the script id

Throws:

JavetException - the javet exception

getStatus

public int getStatus()
              throws JavetException

Description copied from interface: IV8Module

Gets status.

Specified by:

getStatus in interface IV8Module

Returns:

the status

Throws:

JavetException - the javet exception

getType

public V8ValueReferenceType getType()

Specified by:

getType in interface IV8ValueReference

Specified by:

getType in class V8ValueReference

instantiate

public boolean instantiate()
                    throws JavetException

Description copied from interface: IV8Module

Instantiate.

Specified by:

instantiate in interface IV8Module

Returns:

true : instantiated, false : not instantiated

Throws:

JavetException - the javet exception

isSourceTextModule

public boolean isSourceTextModule()
                           throws JavetException

Description copied from interface: IV8Module

Is source text module.

Specified by:

isSourceTextModule in interface IV8Module

Returns:

true : yes, false : no

Throws:

JavetException - the javet exception

isSyntheticModule

public boolean isSyntheticModule()
                          throws JavetException

Description copied from interface: IV8Module

Is synthetic module.

Specified by:

isSyntheticModule in interface IV8Module

Returns:

true : yes, false : no

Throws:

JavetException - the javet exception

toClone

@CheckReturnValue
public V8Module toClone(boolean referenceCopy)
                                    throws JavetException

Description copied from interface: IV8Cloneable

Get a clone of the current V8 value.

Specified by:

toClone in interface IV8Cloneable

Overrides:

toClone in class V8ValueReference

Parameters:

referenceCopy - the reference copy

Returns:

the cloned V8 value

Throws:

JavetException - the javet exception

toString

public java.lang.String toString()

Overrides:

toString in class V8ValueReference