dev.jeka.core.api.tooling.nativ

Class JkNativeCompilation

java.lang.Object

dev.jeka.core.api.tooling.nativ.JkNativeCompilation

public class JkNativeCompilation
extends java.lang.Object

Handles native compilation to produce executables from a list of JAR files.

This class enables users to generate a native executable by providing:

• A list of JAR files
• Optional configuration parameters

Native Compilation Flow

The process of generating a native executable involves several steps:

1. Fetch the AOT (Ahead Of Time) metadata repository. This provides additional metadata to help the compiler.
2. Prepare the command-line arguments needed for the GraalVM nativeImage program.
3. Verify the availability of GraalVM on the system. Download it if not already present.
4. Use the GraalVM nativeImage program to compile the JAR files into a native executable.

Configuration Options

Users can configure the native compilation process via the following options:

• Static linking of the libc library. Levels: NONE, MOSTLY, and MUSL.
• Main class: Specify the main class to be executed in the resulting native executable.
• Resource inclusion: Decide whether to bundle all runtime resources into the executable.
• Raw parameters: Provide custom arguments to the GraalVM nativeImage command for advanced setup.

GraalVM Setup

The GraalVM distribution used for native compilation is selected based on the following precedence:

• If the JEKA_GRAALVM_HOME environment variable is defined, its value is used as the GraalVM path.
• If the environment variable starts with DOWNLOAD_ (e.g., DOWNLOAD_21), GraalVM is downloaded from the internet if it is not already present in the local Jeka cache.
• If running on an existing GraalVM, that version is used automatically unless otherwise specified.
• If no other configuration is provided, a hardcoded GraalVM version is downloaded from the internet.

Using the Class

After configuring the input JARs and compilation options, use the make method to start the compilation process. The resulting executable will be produced in the output path.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	JkNativeCompilation.ReachabilityMetadata
static class	JkNativeCompilation.StaticLink

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_GRAALVM_VERSION
static java.lang.String	DEFAULT_REPO_VERSION
JkNativeCompilation.ReachabilityMetadata	reachabilityMetadata

Method Summary

Modifier and Type	Method and Description
JkNativeCompilation	addExtraParams(java.lang.String... params)
java.util.List<java.nio.file.Path>	getAotMetadataRepoPaths()
java.util.List<java.nio.file.Path>	getClasspath()
java.util.List<java.lang.String>	getNativeImageParams(java.lang.String outputFile, java.lang.String classpathAsString)
JkNativeCompilation.StaticLink	getStaticLinkage()
void	make(java.nio.file.Path outputFile) Generates a native image at the specified file location.
static JkNativeCompilation	ofClasspath(java.util.List<java.nio.file.Path> classpath)
JkNativeCompilation	setIncludesAllResources(boolean includesAllResources)
JkNativeCompilation	setMainClass(java.lang.String mainClass)
JkNativeCompilation	setStaticLinkage(JkNativeCompilation.StaticLink staticLink)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_GRAALVM_VERSION

public static final java.lang.String DEFAULT_GRAALVM_VERSION

See Also:

Constant Field Values

DEFAULT_REPO_VERSION

public static final java.lang.String DEFAULT_REPO_VERSION

See Also:

Constant Field Values

reachabilityMetadata

public final JkNativeCompilation.ReachabilityMetadata reachabilityMetadata

Method Detail

ofClasspath

public static JkNativeCompilation ofClasspath(java.util.List<java.nio.file.Path> classpath)

setStaticLinkage

public JkNativeCompilation setStaticLinkage(JkNativeCompilation.StaticLink staticLink)

addExtraParams

public JkNativeCompilation addExtraParams(java.lang.String... params)

setMainClass

public JkNativeCompilation setMainClass(java.lang.String mainClass)

setIncludesAllResources

public JkNativeCompilation setIncludesAllResources(boolean includesAllResources)

getClasspath

public java.util.List<java.nio.file.Path> getClasspath()

getStaticLinkage

public JkNativeCompilation.StaticLink getStaticLinkage()

getAotMetadataRepoPaths

public java.util.List<java.nio.file.Path> getAotMetadataRepoPaths()

make

public void make(java.nio.file.Path outputFile)

Generates a native image at the specified file location.

getNativeImageParams

public java.util.List<java.lang.String> getNativeImageParams(java.lang.String outputFile,
                                                             java.lang.String classpathAsString)