Package io.quarkus.deployment.builditem.nativeimage

Enum Class FfmDowncallBuildItem.CriticalOption

java.lang.Object

java.lang.Enum<FfmDowncallBuildItem.CriticalOption>

io.quarkus.deployment.builditem.nativeimage.FfmDowncallBuildItem.CriticalOption

All Implemented Interfaces:

Serializable, Comparable<FfmDowncallBuildItem.CriticalOption>, Constable

Enclosing class:

FfmDowncallBuildItem

public static enum FfmDowncallBuildItem.CriticalOption
extends Enum<FfmDowncallBuildItem.CriticalOption>

Specifies whether a critical downcall allows the native function to access Java heap objects during execution.

Critical calls skip safepoints and GC, which improves performance but restricts what the native function can do.

See Also:

• GraalVM FFM Linker Options

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALLOW_HEAP_ACCESS	Critical call where the native function may access Java heap objects.
NO_HEAP_ACCESS	Critical call where the native function must NOT access Java heap objects.

Method Summary

Modifier and Type	Method	Description
boolean	allowHeapAccess()
static FfmDowncallBuildItem.CriticalOption	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FfmDowncallBuildItem.CriticalOption[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NO_HEAP_ACCESS

public static final FfmDowncallBuildItem.CriticalOption NO_HEAP_ACCESS

Critical call where the native function must NOT access Java heap objects.

ALLOW_HEAP_ACCESS

public static final FfmDowncallBuildItem.CriticalOption ALLOW_HEAP_ACCESS

Critical call where the native function may access Java heap objects.

Method Details

values

public static FfmDowncallBuildItem.CriticalOption[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static FfmDowncallBuildItem.CriticalOption valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

allowHeapAccess

public boolean allowHeapAccess()