Package org.graalvm.buildtools.gradle.dsl

Interface GraalVMExtension

All Known Implementing Classes:

DefaultGraalVmExtension

public interface GraalVMExtension

This is the entry point for configuring GraalVM relative features provided by this plugin.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	GraalVMExtension.TestBinaryConfig

Method Summary

Modifier and Type	Method	Description
void	agent(org.gradle.api.Action<? super AgentOptions> spec)
void	binaries(org.gradle.api.Action<? super org.gradle.api.NamedDomainObjectContainer<NativeImageOptions>> spec)	Configures the native image options.
AgentOptions	getAgent()
org.gradle.api.NamedDomainObjectContainer<NativeImageOptions>	getBinaries()	Returns the native image configurations used to generate images.
org.gradle.api.file.DirectoryProperty	getGeneratedResourcesDirectory()
org.gradle.api.provider.Property<java.lang.Boolean>	getTestSupport()	Determines if test support is active.
org.gradle.api.provider.Property<java.lang.Boolean>	getToolchainDetection()	Property driving the detection of toolchains which support building native images.
org.gradle.api.provider.Property<java.lang.Boolean>	getUseArgFile()	Property driving the use of @-arg files when invoking native image.
void	registerTestBinary(java.lang.String name, org.gradle.api.Action<? super GraalVMExtension.TestBinaryConfig> spec)	Registers a new native image binary with testing support.

Method Detail

getTestSupport

org.gradle.api.provider.Property<java.lang.Boolean> getTestSupport()

Determines if test support is active. This can be used to disable automatic test support, especially in cases where the test framework doesn't allow testing within a native image.

getAgent

AgentOptions getAgent()

agent

void agent(org.gradle.api.Action<? super AgentOptions> spec)

getGeneratedResourcesDirectory

org.gradle.api.file.DirectoryProperty getGeneratedResourcesDirectory()

getBinaries

org.gradle.api.NamedDomainObjectContainer<NativeImageOptions> getBinaries()

Returns the native image configurations used to generate images. By default, this plugin creates two images, one called "main" for the main application and another one called "test" for tests.

binaries

void binaries(org.gradle.api.Action<? super org.gradle.api.NamedDomainObjectContainer<NativeImageOptions>> spec)

Configures the native image options.

registerTestBinary

void registerTestBinary(java.lang.String name,
                        org.gradle.api.Action<? super GraalVMExtension.TestBinaryConfig> spec)

Registers a new native image binary with testing support.

Parameters:

spec - the test image configuration

getToolchainDetection

org.gradle.api.provider.Property<java.lang.Boolean> getToolchainDetection()

Property driving the detection of toolchains which support building native images. The default is true.

getUseArgFile

org.gradle.api.provider.Property<java.lang.Boolean> getUseArgFile()

Property driving the use of @-arg files when invoking native image. This is enabled by default on Windows. For older native-image versions, this needs to be disabled.

Returns:

the argument file property