io.micronaut.gradle.graalvm

Class NativeImageTask

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

org.gradle.api.internal.ConventionTask

org.gradle.api.tasks.AbstractExecTask<NativeImageTask>

io.micronaut.gradle.graalvm.NativeImageTask

All Implemented Interfaces:

NativeImageOptions, java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.process.BaseExecSpec, org.gradle.process.ExecSpec, org.gradle.process.ProcessForkOptions, org.gradle.util.Configurable<org.gradle.api.Task>

public class NativeImageTask
extends org.gradle.api.tasks.AbstractExecTask<NativeImageTask>
implements NativeImageOptions

A gradle task for building a native image.

Since:

1.0.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Task

org.gradle.api.Task.Namer

Field Summary

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor and Description
NativeImageTask() Default constructor.

Method Summary

Modifier and Type	Method and Description
NativeImageOptions	classpath(java.lang.Object... paths) Adds elements to the classpath for executing the main class.
void	configure() Configure the task.
NativeImageOptions	debug(boolean debug) Builds a native image with debug symbols
NativeImageOptions	enableServerBuild(boolean enabled) Enables server build.
protected void	exec()
NativeImageOptions	fallback(boolean fallback) Sets whether to enable a fallback or not
org.gradle.api.file.FileCollection	getClasspath() Returns the classpath for executing the main class.
org.gradle.api.provider.Property<java.lang.String>	getImageName() Gets the name of the native executable to be generated.
org.gradle.api.provider.ListProperty<java.lang.String>	getJvmArgs() Returns the extra arguments to use to launch the JVM for the process.
org.gradle.api.provider.Property<java.lang.String>	getMain() Returns the fully qualified name of the Main class to be executed.
java.io.File	getNativeImageOutput()
protected org.gradle.api.model.ObjectFactory	getObjectFactory()
org.gradle.api.provider.MapProperty<java.lang.String,java.lang.Object>	getSystemProperties() Returns the system properties which will be used for the process.
org.gradle.api.provider.Property<java.lang.Boolean>	isDebug()
org.gradle.api.provider.Property<java.lang.Boolean>	isFallback()
org.gradle.api.provider.Property<java.lang.Boolean>	isServerBuild()
org.gradle.api.provider.Property<java.lang.Boolean>	isVerbose()
NativeImageOptions	jvmArgs(java.lang.Iterable<?> arguments) Adds some arguments to use to launch the JVM for the process.
NativeImageOptions	jvmArgs(java.lang.Object... arguments) Adds some arguments to use to launch the JVM for the process.
NativeImageOptions	setClasspath(org.gradle.api.file.FileCollection classpath) Sets the classpath for executing the main class.
NativeImageOptions	setImageName(java.lang.String name) Sets the name of the native executable to be generated.
void	setJvmArgs(java.lang.Iterable<?> arguments) Sets the extra arguments to use to launch the JVM for the process.
void	setJvmArgs(java.util.List<java.lang.String> arguments) Sets the extra arguments to use to launch the JVM for the process.
NativeImageOptions	setMain(java.lang.String main) Sets the fully qualified name of the main class to be executed.
void	setSystemProperties(java.util.Map<java.lang.String,?> properties) Sets the system properties to use for the process.
NativeImageOptions	systemProperties(java.util.Map<java.lang.String,?> properties) Adds some system properties to use for the process.
NativeImageOptions	systemProperty(java.lang.String name, java.lang.Object value) Adds a system property to use for the process.
NativeImageOptions	verbose(boolean verbose) Sets the native image build to be verbose

Methods inherited from class org.gradle.api.tasks.AbstractExecTask

args, args, commandLine, commandLine, copyTo, environment, environment, executable, getArgs, getArgumentProviders, getCommandLine, getEnvironment, getErrorOutput, getExecActionFactory, getExecResult, getExecutable, getExecutionResult, getStandardInput, getStandardOutput, getWorkingDir, isIgnoreExitValue, setArgs, setArgs, setCommandLine, setCommandLine, setCommandLine, setEnvironment, setErrorOutput, setExecutable, setExecutable, setIgnoreExitValue, setStandardInput, setStandardOutput, setWorkingDir, setWorkingDir, workingDir

Methods inherited from class org.gradle.api.internal.ConventionTask

conventionMapping, conventionMapping, getConventionMapping

Methods inherited from class org.gradle.api.internal.AbstractTask

appendParallelSafeAction, compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getRequiredServices, getServices, getSharedResources, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTaskIdentity, getTemporaryDir, getTemporaryDirFactory, getTimeout, hasProperty, hasTaskActions, injectIntoNewInstance, isEnabled, isHasCustomActions, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, replaceLogger, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.gradle.graalvm.NativeImageOptions

args, args, setArgs, setArgs

Constructor Detail

NativeImageTask

public NativeImageTask()

Default constructor.

Method Detail

isFallback

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

Specified by:

isFallback in interface NativeImageOptions

Returns:

Whether to enable fallbacks (defaults to false).

getObjectFactory

@Inject
protected org.gradle.api.model.ObjectFactory getObjectFactory()

Overrides:

getObjectFactory in class org.gradle.api.tasks.AbstractExecTask<NativeImageTask>

getNativeImageOutput

@OutputFile
public java.io.File getNativeImageOutput()

exec

protected void exec()

Overrides:

exec in class org.gradle.api.tasks.AbstractExecTask<NativeImageTask>

configure

public void configure()

Configure the task.

getImageName

public org.gradle.api.provider.Property<java.lang.String> getImageName()

Description copied from interface: NativeImageOptions

Gets the name of the native executable to be generated.

Specified by:

getImageName in interface NativeImageOptions

setImageName

public NativeImageOptions setImageName(@Nullable
                                       java.lang.String name)

Description copied from interface: NativeImageOptions

Sets the name of the native executable to be generated.

Specified by:

setImageName in interface NativeImageOptions

Parameters:

name - The name.

Returns:

this

getMain

public org.gradle.api.provider.Property<java.lang.String> getMain()

Description copied from interface: NativeImageOptions

Returns the fully qualified name of the Main class to be executed.

This does not need to be set if using an Executable Jar with a Main-Class attribute.

Specified by:

getMain in interface NativeImageOptions

setMain

public NativeImageOptions setMain(java.lang.String main)

Description copied from interface: NativeImageOptions

Sets the fully qualified name of the main class to be executed.

Specified by:

setMain in interface NativeImageOptions

Parameters:

main - the fully qualified name of the main class to be executed.

Returns:

this

getSystemProperties

public org.gradle.api.provider.MapProperty<java.lang.String,java.lang.Object> getSystemProperties()

Description copied from interface: NativeImageOptions

Returns the system properties which will be used for the process.

Specified by:

getSystemProperties in interface NativeImageOptions

Returns:

The system properties. Returns an empty map when there are no system properties.

setSystemProperties

public void setSystemProperties(java.util.Map<java.lang.String,?> properties)

Description copied from interface: NativeImageOptions

Sets the system properties to use for the process.

Specified by:

setSystemProperties in interface NativeImageOptions

Parameters:

properties - The system properties. Must not be null.

systemProperties

public NativeImageOptions systemProperties(java.util.Map<java.lang.String,?> properties)

Description copied from interface: NativeImageOptions

Adds some system properties to use for the process.

Specified by:

systemProperties in interface NativeImageOptions

Parameters:

properties - The system properties. Must not be null.

Returns:

this

systemProperty

public NativeImageOptions systemProperty(java.lang.String name,
                                         java.lang.Object value)

Description copied from interface: NativeImageOptions

Adds a system property to use for the process.

Specified by:

systemProperty in interface NativeImageOptions

Parameters:

name - The name of the property

value - The value for the property. May be null.

Returns:

this

classpath

public NativeImageOptions classpath(java.lang.Object... paths)

Description copied from interface: NativeImageOptions

Adds elements to the classpath for executing the main class.

Specified by:

classpath in interface NativeImageOptions

Parameters:

paths - classpath elements

Returns:

this

getClasspath

public org.gradle.api.file.FileCollection getClasspath()

Description copied from interface: NativeImageOptions

Returns the classpath for executing the main class.

Specified by:

getClasspath in interface NativeImageOptions

setClasspath

public NativeImageOptions setClasspath(org.gradle.api.file.FileCollection classpath)

Description copied from interface: NativeImageOptions

Sets the classpath for executing the main class.

Specified by:

setClasspath in interface NativeImageOptions

Parameters:

classpath - the classpath

Returns:

this

getJvmArgs

public org.gradle.api.provider.ListProperty<java.lang.String> getJvmArgs()

Description copied from interface: NativeImageOptions

Returns the extra arguments to use to launch the JVM for the process. Does not include system properties and the minimum/maximum heap size.

Specified by:

getJvmArgs in interface NativeImageOptions

Returns:

The arguments. Returns an empty list if there are no arguments.

setJvmArgs

public void setJvmArgs(@Nullable
                       java.util.List<java.lang.String> arguments)

Description copied from interface: NativeImageOptions

Sets the extra arguments to use to launch the JVM for the process. System properties and minimum/maximum heap size are updated.

Specified by:

setJvmArgs in interface NativeImageOptions

Parameters:

arguments - The arguments. Must not be null.

setJvmArgs

public void setJvmArgs(@Nullable
                       java.lang.Iterable<?> arguments)

Description copied from interface: NativeImageOptions

Sets the extra arguments to use to launch the JVM for the process. System properties and minimum/maximum heap size are updated.

Specified by:

setJvmArgs in interface NativeImageOptions

Parameters:

arguments - The arguments. Must not be null.

jvmArgs

public NativeImageOptions jvmArgs(java.lang.Iterable<?> arguments)

Description copied from interface: NativeImageOptions

Adds some arguments to use to launch the JVM for the process.

Specified by:

jvmArgs in interface NativeImageOptions

Parameters:

arguments - The arguments. Must not be null.

Returns:

this

jvmArgs

public NativeImageOptions jvmArgs(java.lang.Object... arguments)

Description copied from interface: NativeImageOptions

Adds some arguments to use to launch the JVM for the process.

Specified by:

jvmArgs in interface NativeImageOptions

Parameters:

arguments - The arguments.

Returns:

this

verbose

public NativeImageOptions verbose(boolean verbose)

Description copied from interface: NativeImageOptions

Sets the native image build to be verbose

Specified by:

verbose in interface NativeImageOptions

Returns:

this

enableServerBuild

public NativeImageOptions enableServerBuild(boolean enabled)

Description copied from interface: NativeImageOptions

Enables server build. Server build is disabled by default

Specified by:

enableServerBuild in interface NativeImageOptions

Returns:

this

debug

public NativeImageOptions debug(boolean debug)

Description copied from interface: NativeImageOptions

Builds a native image with debug symbols

Specified by:

debug in interface NativeImageOptions

Returns:

this

fallback

public NativeImageOptions fallback(boolean fallback)

Description copied from interface: NativeImageOptions

Sets whether to enable a fallback or not

Specified by:

fallback in interface NativeImageOptions

Returns:

this

isDebug

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

Specified by:

isDebug in interface NativeImageOptions

Returns:

Is debug enabled

isVerbose

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

Specified by:

isVerbose in interface NativeImageOptions

Returns:

Is verbose output

isServerBuild

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

Specified by:

isServerBuild in interface NativeImageOptions

Returns:

Should the build run on a server (defaults to false).