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.

  • Method Details

    • getTestSupport

      org.gradle.api.provider.Property<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.
      Returns:
      is the test support active

    • 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.
      Returns:
      configuration for binaries

    • binaries

      void binaries(org.gradle.api.Action<? super org.gradle.api.NamedDomainObjectContainer<NativeImageOptions>> spec)
      Configures the native image options.
      Parameters:
      spec - specification for binary

    • registerTestBinary

      void registerTestBinary(String name, org.gradle.api.Action<? super GraalVMExtension.TestBinaryConfig> spec)
      Registers a new native image binary with testing support.
      Parameters:
      name - the name of the binary
      spec - the test image configuration

    • getToolchainDetection

      org.gradle.api.provider.Property<Boolean> getToolchainDetection()
      Property driving the detection of toolchains which support building native images. The default is false.
      Returns:
      is toolchain detection on

    • getUseArgFile

      org.gradle.api.provider.Property<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