app.cash.quickjs

Class QuickJs

java.lang.Object

app.cash.quickjs.QuickJs

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public final class QuickJs
extends java.lang.Object
implements java.io.Closeable

An EMCAScript (Javascript) interpreter backed by the 'QuickJS' native engine.

This class is NOT thread safe. If multiple threads access an instance concurrently it must be externally.

Method Summary

Modifier and Type	Method and Description
void	close() Release the native resources associated with this object.
byte[]	compile(java.lang.String sourceCode, java.lang.String fileName) Compile sourceCode and return the bytecode.
static QuickJs	create() Create a new interpreter instance.
java.lang.Object	evaluate(java.lang.String script) Evaluate script and return a result.
java.lang.Object	evaluate(java.lang.String script, java.lang.String fileName) Evaluate script and return any result.
java.lang.Object	execute(byte[] bytecode) Load and execute bytecode and return the result.
protected void	finalize()
<T> T	get(java.lang.String name, java.lang.Class<T> type) Attaches to a global JavaScript object called name that implements type.
<T> void	set(java.lang.String name, java.lang.Class<T> type, T object) Provides object to JavaScript as a global object called name.

Methods inherited from class java.lang.Object

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

Method Detail

create

@NonNull
public static QuickJs create()

Create a new interpreter instance. Calls to this method must matched with calls to close() on the returned instance to avoid leaking native memory.

evaluate

@Nullable
public java.lang.Object evaluate(@NonNull
                                           java.lang.String script,
                                           @NonNull
                                           java.lang.String fileName)

Evaluate script and return any result. fileName will be used in error reporting.

Throws:

QuickJsException - if there is an error evaluating the script.

evaluate

@Nullable
public java.lang.Object evaluate(@NonNull
                                           java.lang.String script)

Evaluate script and return a result.

Throws:

QuickJsException - if there is an error evaluating the script.

set

public <T> void set(@NonNull
                    java.lang.String name,
                    @NonNull
                    java.lang.Class<T> type,
                    @NonNull
                    T object)

Provides object to JavaScript as a global object called name. type defines the interface implemented by object that will be accessible to JavaScript. type must be an interface that does not extend any other interfaces, and cannot define any overloaded methods.

Methods of the interface may return void or any of the following supported argument types: boolean, Boolean, int, Integer, double, Double, String.

get

@NonNull
public <T> T get(@NonNull
                          java.lang.String name,
                          @NonNull
                          java.lang.Class<T> type)

Attaches to a global JavaScript object called name that implements type. type defines the interface implemented in JavaScript that will be accessible to Java. type must be an interface that does not extend any other interfaces, and cannot define any overloaded methods.

Methods of the interface may return void or any of the following supported argument types: boolean, Boolean, int, Integer, double, Double, String.

compile

@NonNull
public byte[] compile(@NonNull
                               java.lang.String sourceCode,
                               @NonNull
                               java.lang.String fileName)

Compile sourceCode and return the bytecode. fileName will be used in error reporting.

Throws:

QuickJsException - if the sourceCode could not be compiled.

execute

@Nullable
public java.lang.Object execute(@NonNull
                                          byte[] bytecode)

Load and execute bytecode and return the result.

Throws:

QuickJsException - if there is an error loading or executing the code.

close

public void close()

Release the native resources associated with this object. You must call this method for each instance to avoid leaking native memory.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object