Package org.graalvm.nativeimage

The Graal-SDK native-image API allows to customize the native image generation, i.e., the ahead-of-time compilation of Java code to standalone executables.

See: Description

Interface Summary

Interface	Description
Feature	Features allow clients to intercept the native image generation and run custom initialization code at various stages.
Feature.AfterAnalysisAccess	Access methods available for Feature.afterAnalysis(org.graalvm.nativeimage.Feature.AfterAnalysisAccess).
Feature.AfterCompilationAccess	Access methods available for Feature.afterCompilation(org.graalvm.nativeimage.Feature.AfterCompilationAccess).
Feature.AfterHeapLayoutAccess	Access methods available for Feature.afterHeapLayout(org.graalvm.nativeimage.Feature.AfterHeapLayoutAccess).
Feature.AfterImageWriteAccess	Access methods available for Feature.afterImageWrite(org.graalvm.nativeimage.Feature.AfterImageWriteAccess).
Feature.AfterRegistrationAccess	Access methods available for Feature.afterRegistration(org.graalvm.nativeimage.Feature.AfterRegistrationAccess).
Feature.BeforeAnalysisAccess	Access methods available for Feature.beforeAnalysis(org.graalvm.nativeimage.Feature.BeforeAnalysisAccess).
Feature.BeforeCompilationAccess	Access methods available for Feature.beforeCompilation(org.graalvm.nativeimage.Feature.BeforeCompilationAccess).
Feature.BeforeImageWriteAccess	Access methods available for Feature.beforeImageWrite(org.graalvm.nativeimage.Feature.BeforeImageWriteAccess).
Feature.CompilationAccess	Access methods available for Feature.beforeCompilation(org.graalvm.nativeimage.Feature.BeforeCompilationAccess) and Feature.afterCompilation(org.graalvm.nativeimage.Feature.AfterCompilationAccess).
Feature.DuringAnalysisAccess	Access methods available for Feature.duringAnalysis(org.graalvm.nativeimage.Feature.DuringAnalysisAccess).
Feature.DuringSetupAccess	Access methods available for Feature.duringSetup(org.graalvm.nativeimage.Feature.DuringSetupAccess).
Feature.FeatureAccess	Access methods that are available for all feature methods.
Feature.IsInConfigurationAccess	Access methods available for Feature.isInConfiguration(org.graalvm.nativeimage.Feature.IsInConfigurationAccess).
Feature.OnAnalysisExitAccess	Access methods available for Feature.onAnalysisExit(org.graalvm.nativeimage.Feature.OnAnalysisExitAccess).
Isolate	Pointer to the runtime data structure for an isolate.
IsolateThread	Pointer to the runtime data structure for a thread.
LogHandler	Low-level handler for log messages of native images.
ObjectHandle	The opaque representation of a handle to a Java object given out to C 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.AMD64	Supported architecture: x86 64-bit.
Platform.DARWIN	Supported operating system: Darwin (MacOS).
Platform.LINUX	Supported operating system: Linux.
Platform.WINDOWS	Supported operating system: Windows.
Threading.RecurringCallback	Interface that a callback handler needs to implement.
Threading.RecurringCallbackAccess	Provides methods that are available during the execution of a Threading.RecurringCallback.

Class Summary

Class	Description
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.
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.
Platform.DARWIN_AMD64	Supported leaf platform: Darwin (MacOS) on x86 64-bit.
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.LINUX_AMD64	Supported leaf platform: Linux on x86 64-bit.
Platform.WINDOWS_AMD64	Supported leaf platform: Windows on x86 64-bit.
ProcessProperties	Utility class to get and set properties of the OS process at run time.
RuntimeClassInitialization	This class provides methods that can be called during native image building to configure class initialization behavior.
RuntimeOptions	Used for manipulating options at run time.
RuntimeReflection	This class provides methods that can be called during native image generation to register classes, methods, and fields for reflection at run time.
StackValue	Contains static methods for memory allocation in the stack frame.
Threading	Functionality related to execution in threads.
UnmanagedMemory	Contains static methods that allow allocate/free of unmanaged memory, i.e., memory that is not under the control of the garbage collector.

Exception Summary

Exception	Description
Isolates.IsolateException	An exception thrown in the context of managing isolates.

Annotation Types Summary

Annotation Type	Description
Platforms	Restricts the annotated element (type, method, or field) to the specified Platform groups.

Package org.graalvm.nativeimage Description

The Graal-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:

1.0