Package org.graalvm.nativeimage

package org.graalvm.nativeimage

The GraalVM SDK Native Image API allows to customize the native image generation, i.e., the ahead-of-time compilation of Java code to standalone executables. It also provides interfaces and support classes that only work in the context of a native image.

Since:

19.0

Related Packages

Package	Description
org.graalvm.nativeimage.c	This package and its sub-packages provide a fast and lightweight interface between Java code and C code.
org.graalvm.nativeimage.hosted	The GraalVM SDK Native Image API allows to customize the native image generation, i.e., the ahead-of-time compilation of Java code to standalone executables: Features allow clients to intercept the native image generation and run custom initialization code at various stages. RuntimeClassInitialization is used to configure when classes are initialized. RuntimeReflection to register classes, methods, and fields for reflection at run time.

Class	Description
AnnotationAccess	This class provides methods to query annotation information on AnnotatedElements while trying to prevent, at image build time, side-effecting changes that impact the analysis results.
CurrentIsolate	Utility methods that provide access to the current isolate.
ImageInfo	Utility class to retrieve information about the context in which code gets executed.
ImageSingletons	A key-value store of singleton objects.
Isolate	Pointer to the runtime data structure for an isolate.
Isolates	Support for the creation, access to, and tear-down of isolates.
Isolates.CreateIsolateParameters	Parameters for the creation of an isolate.
Isolates.CreateIsolateParameters.Builder	Builder for a Isolates.CreateIsolateParameters instance.
Isolates.IsolateException	An exception thrown in the context of managing isolates.
Isolates.ProtectionDomain	Identifies a protection domain for an isolate.
IsolateThread	Pointer to the runtime data structure for a thread.
LogHandler	Low-level handler for log messages of native images.
MissingJNIRegistrationError	This exception is thrown when a JNI query tries to access an element that was not registered for JNI access in the program.
MissingReflectionRegistrationError	This exception is thrown when a reflective query (such as Class.getMethod(String, Class[])) tries to access an element that was not registered for reflection in the program.
ObjectHandle	The opaque representation of a handle to a Java object given out to unmanaged code.
ObjectHandles	Manages a set of ObjectHandles.
PinnedObject	Holder for a pinned object, such that the object doesn't move until the pin is removed.
Platform	Root of the interface hierarchy for architectures, OS, and supported combinations of them.
Platform.AARCH64	Supported architecture: ARMv8 64-bit.
Platform.AMD64	Supported architecture: x86 64-bit.
Platform.ANDROID	Supported operating system: Android.
Platform.ANDROID_AARCH64	Supported leaf platform: Android on AArch64 64-bit.
Platform.DARWIN	Basis for all Apple operating systems (MacOS and iOS).
Platform.DARWIN_AARCH64	Basis for all Apple operating systems on AMD64 (MACOS_AMD64 & IOS_AMD64).
Platform.DARWIN_AMD64	Basis for all Apple operating systems on AMD64 (MACOS_AMD64 & IOS_AMD64).
Platform.HOSTED_ONLY	Marker for elements (types, methods, or fields) that are only visible during native image generation and cannot be used at run time, regardless of the actual platform.
Platform.IOS	Supported operating system: iOS.
Platform.IOS_AARCH64	Supported leaf platform: iOS on AArch 64-bit.
Platform.IOS_AMD64	Supported leaf platform: iOS on x86 64-bit.
Platform.LINUX	Supported operating system: Linux.
Platform.LINUX_AARCH64	Supported leaf platform: Linux on AArch64 64-bit.
Platform.LINUX_AARCH64_BASE	Basis for all Linux operating systems on AARCH64 (LINUX_AARCH64 & ANDROID_AARCH64).
Platform.LINUX_AMD64	Supported leaf platform: Linux on x86 64-bit.
Platform.LINUX_AMD64_BASE	Basis for all Linux operating systems on AMD64 (LINUX_AMD64).
Platform.LINUX_RISCV64	Supported leaf platform: Linux on RISC-V 64-bit.
Platform.MACOS	Supported operating system: MacOS.
Platform.MACOS_AARCH64	Supported leaf platform: MacOS on AArch 64-bit.
Platform.MACOS_AMD64	Supported leaf platform: MacOS on x86 64-bit.
Platform.RISCV64	Supported architecture: RISC-V 64-bit.
Platform.WINDOWS	Supported operating system: Windows.
Platform.WINDOWS_AARCH64	Supported leaf platform: Windows on AArch 64-bit.
Platform.WINDOWS_AMD64	Supported leaf platform: Windows on x86 64-bit.
Platforms	Restricts the annotated element (type, method, or field) to the specified Platform groups.
ProcessProperties	Utility class to get and set properties of the OS process at run time.
RuntimeOptions	Used for manipulating options at run time.
RuntimeOptions.Descriptor
StackValue	Contains static methods for memory allocation in the stack frame.
Threading	Functionality related to execution in threads.
Threading.RecurringCallback	Interface that a callback handler needs to implement.
Threading.RecurringCallbackAccess	Provides methods that are available during the execution of a Threading.RecurringCallback.
UnmanagedMemory	Contains static methods that allow allocate/free of unmanaged memory, i.e., memory that is not under the control of the garbage collector.
VMRuntime	Used for doing VM runtime operations.