Class JNIConfig.Builder

java.lang.Object

org.graalvm.nativebridge.JNIConfig.Builder

Enclosing class:

JNIConfig

public static final class JNIConfig.Builder
extends Object

A builder class to construct JNIConfig instances.

Method Summary

Modifier and Type	Method	Description
JNIConfig	build()	Builds the JNIConfig.
static BinaryMarshaller<StackTraceElement[]>	defaultStackTraceMarshaller()	Returns a BinaryMarshaller for stack trace marshalling.
<T> JNIConfig.Builder	registerMarshaller(Class<T> type, Class<? extends Annotation> annotationType, BinaryMarshaller<T> marshaller)	Registers a BinaryMarshaller for the type and annotationType.
<T> JNIConfig.Builder	registerMarshaller(Class<T> type, BinaryMarshaller<T> marshaller)	Registers a BinaryMarshaller for the type.
<T> JNIConfig.Builder	registerMarshaller(TypeLiteral<T> parameterizedType, Class<? extends Annotation> annotationType, BinaryMarshaller<T> marshaller)	Registers a BinaryMarshaller for the parameterizedType and annotationType.
<T> JNIConfig.Builder	registerMarshaller(TypeLiteral<T> parameterizedType, BinaryMarshaller<T> marshaller)	Registers a BinaryMarshaller for the parameterizedType.
JNIConfig.Builder	setAttachThreadAction(LongUnaryOperator action)	Registers a callback used by the NativeIsolate to attach the current thread to an isolate.
JNIConfig.Builder	setDetachThreadAction(LongUnaryOperator action)	Registers a callback used by the NativeIsolate to detach the current thread from an isolate.
JNIConfig.Builder	setNativeThreadLocalFactory(Function<Supplier<NativeIsolateThread>, ThreadLocal<NativeIsolateThread>> factory)	Registers a thread local factory whenever the default thread local handling should be overriden.
JNIConfig.Builder	setReleaseNativeObjectAction(LongBinaryOperator action)	Registers a callback used by the NativeObject to free an object in a native image heap referenced by the garbage-collected handle.
JNIConfig.Builder	setShutDownIsolateAction(LongBinaryOperator action)	Registers a callback used by the NativeIsolate to tear down the isolate.

Methods inherited from class java.lang.Object

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

Method Details

registerMarshaller

public <T> JNIConfig.Builder registerMarshaller(Class<T> type,
 BinaryMarshaller<T> marshaller)

Registers a BinaryMarshaller for the type.

Parameters:

type - the type to register BinaryMarshaller for.

marshaller - the marshaller to register.

registerMarshaller

public <T> JNIConfig.Builder registerMarshaller(TypeLiteral<T> parameterizedType,
 BinaryMarshaller<T> marshaller)

Registers a BinaryMarshaller for the parameterizedType.

Parameters:

parameterizedType - the type to register BinaryMarshaller for.

marshaller - the marshaller to register.

registerMarshaller

public <T> JNIConfig.Builder registerMarshaller(Class<T> type,
 Class<? extends Annotation> annotationType,
 BinaryMarshaller<T> marshaller)

Registers a BinaryMarshaller for the type and annotationType.

Parameters:

type - the type to register BinaryMarshaller for.

annotationType - a required annotation to look up the marshaller.

marshaller - the marshaller to register.

registerMarshaller

public <T> JNIConfig.Builder registerMarshaller(TypeLiteral<T> parameterizedType,
 Class<? extends Annotation> annotationType,
 BinaryMarshaller<T> marshaller)

Registers a BinaryMarshaller for the parameterizedType and annotationType.

Parameters:

parameterizedType - the type to register BinaryMarshaller for.

annotationType - a required annotation to look up the marshaller.

marshaller - the marshaller to register.

setAttachThreadAction

public JNIConfig.Builder setAttachThreadAction(LongUnaryOperator action)

Registers a callback used by the NativeIsolate to attach the current thread to an isolate.

Parameters:

action - a LongUnaryOperator that takes an isolate address as a parameter and returns the isolate thread address.

setDetachThreadAction

public JNIConfig.Builder setDetachThreadAction(LongUnaryOperator action)

Registers a callback used by the NativeIsolate to detach the current thread from an isolate.

Parameters:

action - a LongUnaryOperator that takes an isolate thread address as a parameter and returns 0 on success or non-zero in case of an error.

setShutDownIsolateAction

public JNIConfig.Builder setShutDownIsolateAction(LongBinaryOperator action)

Registers a callback used by the NativeIsolate to tear down the isolate.

Parameters:

action - a LongBinaryOperator that takes an isolate address and an isolate thread address as parameters and returns 0 on success or non-zero in case of an error.

setReleaseNativeObjectAction

public JNIConfig.Builder setReleaseNativeObjectAction(LongBinaryOperator action)

Registers a callback used by the NativeObject to free an object in a native image heap referenced by the garbage-collected handle. At some point after a NativeObject is garbage collected, a call to the action is made to release the corresponding object in the native image heap.

Parameters:

action - a LongBinaryOperator that takes an isolate thread address and object handle as parameters and returns 0 on success or non-zero in case of an error.

See Also:

• NativeObject

setNativeThreadLocalFactory

public JNIConfig.Builder setNativeThreadLocalFactory(Function<Supplier<NativeIsolateThread>, ThreadLocal<NativeIsolateThread>> factory)

Registers a thread local factory whenever the default thread local handling should be overriden. This can be useful to install a terminating thread local using JVMCI services when needed.

See Also:

• NativeObject

build

public JNIConfig build()

Builds the JNIConfig.

defaultStackTraceMarshaller

public static BinaryMarshaller<StackTraceElement[]> defaultStackTraceMarshaller()

Returns a BinaryMarshaller for stack trace marshalling.