gradle/org.gradle.api.tasks/JavaExec

JavaExec

@DisableCachingByDefault(because = "Gradle would require more information to cache this task")

abstract class JavaExec : ConventionTask, JavaExecSpec(source)

Executes a Java application in a child process.

Similar to Exec, but starts a JVM with the given classpath and application class.

plugins {
    id 'java'
}

task runApp(type: JavaExec) {
  classpath = sourceSets.main.runtimeClasspath

  mainClass = 'package.Main'

  // arguments to pass to the application
  args 'appArg1'
}

// Using and creating an Executable Jar
jar {
  manifest {
    attributes('Main-Class': 'package.Main')
  }
}

task runExecutableJar(type: JavaExec) {
  // Executable jars can have only _one_ jar on the classpath.
  classpath = files(tasks.jar)

  // 'main' does not need to be specified

  // arguments to pass to the application
  args 'appArg1'
}

The process can be started in debug mode (see getDebug) in an ad-hoc manner by supplying the `--debug-jvm` switch when invoking the build.

gradle someJavaExecTask --debug-jvm

Also, debug configuration can be explicitly set in debugOptions:

task runApp(type: JavaExec) {
   ...

   debugOptions {
       enabled = true
       port = 5566
       server = true
       suspend = false
   }
}

Constructors

JavaExec

constructor()

Properties

conventionMapping

open val conventionMapping: @Nullable ConventionMapping

description

@get:Nullable

open var description: @Nullable String

enabled

open var enabled: Boolean

group

@get:Nullable

open var group: @Nullable String

impliesSubProjects

open var impliesSubProjects: Boolean

modularity

val modularity: ModularitySpec

state

val state: TaskStateInternal

TASK_ACTION

val TASK_ACTION: String = "action"

TASK_CONSTRUCTOR_ARGS

val TASK_CONSTRUCTOR_ARGS: String = "constructorArgs"

Constructor arguments for the Task

TASK_DEPENDS_ON

val TASK_DEPENDS_ON: String = "dependsOn"

TASK_DESCRIPTION

val TASK_DESCRIPTION: String = "description"

TASK_GROUP

val TASK_GROUP: String = "group"

TASK_NAME

val TASK_NAME: String = "name"

TASK_OVERWRITE

val TASK_OVERWRITE: String = "overwrite"

TASK_TYPE

val TASK_TYPE: String = "type"

timeout

val timeout: Property<Duration>

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec>)

appendParallelSafeAction

open fun appendParallelSafeAction(action: Action<in Task>)

args

open fun args(args: Iterable<out Any>): JavaExecSpec

open fun args(args: Array<Any>): JavaExec

Adds args for the main class to be executed.

bootstrapClasspath

open fun bootstrapClasspath(@Nullable classpath: Array<@Nullable Any>): JavaExec

Adds the given values to the end of the bootstrap classpath for the process.

classpath

open fun classpath(@Nullable paths: Array<@Nullable Any>): JavaExec

Adds elements to the classpath for executing the main class.

compareTo

open fun compareTo(otherTask: Task): Int

configure

open fun configure(closure: Closure): Task

abstract fun configure(configureClosure: Closure): Task

open fun configure(closure: Closure): Task

Applies the statements of the closure against this task object.

abstract fun configure(cl: Closure): T

conventionMapping

open fun conventionMapping(property: String, mapping: Callable<out Any>): Task

copyTo

open fun copyTo(options: JavaForkOptions): JavaExec

Copies these options to the given options.

open fun copyTo(target: ProcessForkOptions): JavaExec

Copies these options to the given target options.

debugOptions

open fun debugOptions(action: Action<JavaDebugOptions>)

Configures Java Debug Wire Protocol properties for the process.

dependsOn

open fun dependsOn(paths: Array<Any>): Task

Adds the given dependencies to this task.

doFirst

open fun doFirst(action: Closure): Task

abstract fun doFirst(@DelegatesTo(value = Task::class) action: Closure): Task

Adds the given closure to the beginning of this task's action list.

open fun doFirst(action: Action<in Task>): Task

open fun doFirst(actionName: String, action: Action<in Task>): Task

open fun doFirst(action: Action<in Task>): Task

Adds the given Action to the beginning of this task's action list.

doLast

open fun doLast(action: Closure): Task

abstract fun doLast(@DelegatesTo(value = Task::class) action: Closure): Task

Adds the given closure to the end of this task's action list.

open fun doLast(action: Action<in Task>): Task

open fun doLast(actionName: String, action: Action<in Task>): Task

open fun doLast(action: Action<in Task>): Task

Adds the given Action to the end of this task's action list.

doNotTrackState

abstract fun doNotTrackState(reasonNotToTrackState: String)

open fun doNotTrackState(reasonNotToTrackState: String)

Do not track the state of the task.

doNotTrackStateIf

open fun doNotTrackStateIf(reason: String, spec: Spec<in TaskInternal>)

environment

open fun environment(environmentVariables: Map<String, out Any>): JavaExec

Adds some environment variables to the environment for this process.

open fun environment(name: String, value: Any): JavaExec

Adds an environment variable to the environment for this process.

exec

open fun exec()

executable

open fun executable(executable: Any): JavaExec

Sets the name of the executable to use.

finalizedBy

open fun finalizedBy(paths: Array<Any>): Task

Adds the given finalizer tasks for this task.

getActions

open fun getActions(): List<Action<in Task>>

Returns the sequence of Action objects which will be executed by this task, in the order of execution.

getAllJvmArgs

open fun getAllJvmArgs(): List<String>

Returns the full set of arguments to use to launch the JVM for the process.

getAnt

open fun getAnt(): AntBuilder

Returns the AntBuilder for this task.

getArgs

open fun getArgs(): List<String>

Returns the arguments passed to the main class to be executed.

getArgumentProviders

open fun getArgumentProviders(): List<CommandLineArgumentProvider>

Argument providers for the application.

getAsDynamicObject

open fun getAsDynamicObject(): DynamicObject

getBootstrapClasspath

open fun getBootstrapClasspath(): FileCollection

Returns the bootstrap classpath to use for the process.

getClasspath

open fun getClasspath(): FileCollection

Returns the classpath for executing the main class.

getCommandLine

@Internal

open fun getCommandLine(): List<String>

Returns the full command line, including the executable plus its arguments.

getDebug

open fun getDebug(): Boolean

Determines whether debugging is enabled for the test process.

getDebugOptions

open fun getDebugOptions(): JavaDebugOptions

Returns the Java Debug Wire Protocol properties for the process.

getDefaultCharacterEncoding

@Nullable

open fun getDefaultCharacterEncoding(): @Nullable String

Returns the default character encoding to use.

getDependsOn

open fun getDependsOn(): Set<Any>

Returns the dependencies of this task.

getDestroyables

open fun getDestroyables(): TaskDestroyables

Returns the destroyables of this task.

getDidWork

open fun getDidWork(): Boolean

Checks if the task actually did any work.

getEnableAssertions

open fun getEnableAssertions(): Boolean

Returns true if assertions are enabled for the process.

getEnvironment

@Internal

open fun getEnvironment(): Map<String, Any>

The environment variables to use for the process.

getErrorOutput

@Internal

open fun getErrorOutput(): OutputStream

Returns the output stream to consume standard error from the process executing the command.

getExecutable

@Internal(value = "covered by getJavaVersion")

@Nullable

open fun getExecutable(): @Nullable String

Returns the name of the executable to use.

getExecutionResult

@Internal

open fun getExecutionResult(): Provider<ExecResult>

Returns the result for the command run by this task.

getExtensions

open fun getExtensions(): ExtensionContainer

The container of extensions.

getFinalizedBy

open fun getFinalizedBy(): TaskDependency

Returns tasks that finalize this task.

getIdentityPath

open fun getIdentityPath(): Path

getInputs

open fun getInputs(): TaskInputsInternal

@Internal

abstract fun getInputs(): TaskInputs

open fun getInputs(): TaskInputsInternal

Returns the inputs of this task.

getJavaLauncher

abstract fun getJavaLauncher(): Property<JavaLauncher>

Configures the java executable to be used to run the tests.

getJavaVersion

@Internal(value = "covered by getJavaLauncher().getMetadata().getLanguageVersion()")

open fun getJavaVersion(): JavaVersion

Returns the version of the Java executable specified by getJavaLauncher.

getJvmArgs

open fun getJvmArgs(): List<String>

Returns the extra arguments to use to launch the JVM for the process.

getJvmArgumentProviders

open fun getJvmArgumentProviders(): List<CommandLineArgumentProvider>

Command line argument providers for the java process to fork.

getJvmArguments

open fun getJvmArguments(): ListProperty<String>

Extra JVM arguments to be to use to launch the JVM for the process.

getLifecycleDependencies

open fun getLifecycleDependencies(): TaskDependencyInternal

abstract fun getLifecycleDependencies(): TaskDependency

getLocalState

open fun getLocalState(): TaskLocalState

Returns the local state of this task.

getLogger

open fun getLogger(): Logger

Returns the logger for this task.

getLogging

open fun getLogging(): LoggingManager

Returns the org.gradle.api.logging.LoggingManager which can be used to receive logging and to control the standard output/error capture for this task.

getMainClass

abstract fun getMainClass(): Property<String>

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

getMainModule

abstract fun getMainModule(): Property<String>

The name of the main module to be executed if the application should run as a Java module.

getMaxHeapSize

@Nullable

open fun getMaxHeapSize(): @Nullable String

Returns the maximum heap size for the process, if any.

getMinHeapSize

@Nullable

open fun getMinHeapSize(): @Nullable String

Returns the minimum heap size for the process, if any.

getMustRunAfter

open fun getMustRunAfter(): TaskDependency

Returns tasks that this task must run after.

getName

open fun getName(): String

Returns the name of this task.

getOnlyIf

open fun getOnlyIf(): Spec<in TaskInternal>

getOutputs

open fun getOutputs(): TaskOutputsInternal

@Internal

abstract fun getOutputs(): TaskOutputs

open fun getOutputs(): TaskOutputsInternal

Returns the outputs of this task.

getPath

open fun getPath(): String

Returns the path of the task, which is a fully qualified name for the task.

getProject

open fun getProject(): Project

Returns the Project which this task belongs to.

getReasonNotToTrackState

open fun getReasonNotToTrackState(): Optional<String>

getReasonsNotToTrackState

open fun getReasonsNotToTrackState(): Set<String>

getReasonTaskIsIncompatibleWithConfigurationCache

open fun getReasonTaskIsIncompatibleWithConfigurationCache(): Optional<String>

getRequiredServices

open fun getRequiredServices(): TaskRequiredServices

getSharedResources

open fun getSharedResources(): List<ResourceLock>

abstract fun getSharedResources(): List<out ResourceLock>

getShouldRunAfter

open fun getShouldRunAfter(): TaskDependency

Returns tasks that this task should run after.

getStandardInput

@Internal

open fun getStandardInput(): InputStream

Returns the standard input stream for the process executing the command.

getStandardOutput

@Internal

open fun getStandardOutput(): OutputStream

Returns the output stream to consume standard output from the process executing the command.

getStandardOutputCapture

open fun getStandardOutputCapture(): StandardOutputCapture

getState

@Internal

abstract fun getState(): TaskState

Returns the execution state of this task.

getSystemProperties

open fun getSystemProperties(): Map<String, @Nullable Any>

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

getTaskActions

open fun getTaskActions(): List<InputChangesAwareTaskAction>

getTaskDependencies

open fun getTaskDependencies(): TaskDependencyInternal

@Internal

abstract fun getTaskDependencies(): TaskDependency

open fun getTaskDependencies(): TaskDependencyInternal

Returns a TaskDependency which contains all the tasks that this task depends on.

getTaskIdentity

open fun getTaskIdentity(): TaskIdentity<out Any>

getTemporaryDir

open fun getTemporaryDir(): File

Returns a directory which this task can use to write temporary files to.

getTemporaryDirFactory

open fun getTemporaryDirFactory(): Factory<File>

getWorkingDir

@Internal

open fun getWorkingDir(): File

Returns the working directory for the process.

hasProperty

open fun hasProperty(propertyName: String): Boolean

Determines if this task has the given property.

hasTaskActions

open fun hasTaskActions(): Boolean

injectIntoNewInstance

open fun <T : Task?> injectIntoNewInstance(project: ProjectInternal, identity: TaskIdentity<T>, factory: Callable<T>): T

isCompatibleWithConfigurationCache

open fun isCompatibleWithConfigurationCache(): Boolean

isEnabled

open fun isEnabled(): Boolean

isHasCustomActions

open fun isHasCustomActions(): Boolean

isIgnoreExitValue

@Input

open fun isIgnoreExitValue(): Boolean

Tells whether a non-zero exit value is ignored, or an exception thrown.

jvmArgs

open fun jvmArgs(arguments: Iterable<out Any>): JavaExec

open fun jvmArgs(arguments: Array<Any>): JavaExec

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

mustRunAfter

open fun mustRunAfter(paths: Array<Any>): Task

Specifies that this task must run after all of the supplied tasks.

notCompatibleWithConfigurationCache

abstract fun notCompatibleWithConfigurationCache(reason: String)

open fun notCompatibleWithConfigurationCache(reason: String)

Specifies that this task is not compatible with the configuration cache.

onlyIf

open fun onlyIf(onlyIfClosure: Closure)

abstract fun onlyIf(onlyIfClosure: Closure<out Any>)

open fun onlyIf(onlyIfClosure: Closure)

Execute the task only if the given closure returns true.

open fun onlyIf(spec: Spec<in Task>)

open fun onlyIf(onlyIfReason: String, spec: Spec<in Task>)

abstract fun onlyIf(onlyIfSpec: Spec<in Task>)

@Incubating

abstract fun onlyIf(onlyIfReason: String, onlyIfSpec: Spec<in Task>)

Execute the task only if the given spec is satisfied.

prependParallelSafeAction

open fun prependParallelSafeAction(action: Action<in Task>)

property

open fun property(propertyName: String): Any

Returns the value of the given property of this task.

restoreOnlyIf

open fun restoreOnlyIf(onlyIf: Spec<in TaskInternal>)

restoreTaskActions

open fun restoreTaskActions(taskActions: List<InputChangesAwareTaskAction>)

setActions

open fun setActions(replacements: List<Action<in Task>>)

abstract fun setActions(actions: List<Action<in Task>>)

open fun setActions(replacements: List<Action<in Task>>)

Sets the sequence of Action objects which will be executed by this task.

setAllJvmArgs

open fun setAllJvmArgs(arguments: Iterable<out Any>)

open fun setAllJvmArgs(arguments: List<String>)

Sets the full set of arguments to use to launch the JVM for the process.

setArgs

open fun setArgs(applicationArgs: Iterable<out Any>): JavaExec

open fun setArgs(applicationArgs: List<String>): JavaExec

Sets the args for the main class to be executed.

setArgsString

open fun setArgsString(args: String): JavaExec

Parses an argument list from args and passes it to setArgs.

setBootstrapClasspath

open fun setBootstrapClasspath(classpath: FileCollection)

Sets the bootstrap classpath to use for the process.

setClasspath

open fun setClasspath(classpath: FileCollection): JavaExec

Sets the classpath for executing the main class.

setDebug

open fun setDebug(enabled: Boolean)

Enable or disable debugging for the process.

setDefaultCharacterEncoding

open fun setDefaultCharacterEncoding(@Nullable defaultCharacterEncoding: @Nullable String)

Sets the default character encoding to use.

setDependsOn

open fun setDependsOn(dependsOn: Iterable<out Any>)

abstract fun setDependsOn(dependsOnTasks: Iterable<out Any>)

open fun setDependsOn(dependsOn: Iterable<out Any>)

Sets the dependencies of this task.

setDidWork

open fun setDidWork(didWork: Boolean)

Sets whether the task actually did any work.

setEnableAssertions

open fun setEnableAssertions(enabled: Boolean)

Enable or disable assertions for the process.

setEnvironment

open fun setEnvironment(environmentVariables: Map<String, out Any>)

Sets the environment variable to use for the process.

setErrorOutput

open fun setErrorOutput(outputStream: OutputStream): JavaExec

Sets the output stream to consume standard error from the process executing the command.

setExecutable

open fun setExecutable(executable: Any)

open fun setExecutable(executable: String)

Sets the name of the executable to use.

setFinalizedBy

open fun setFinalizedBy(finalizedByTasks: Iterable<out Any>)

abstract fun setFinalizedBy(finalizedBy: Iterable<out Any>)

open fun setFinalizedBy(finalizedByTasks: Iterable<out Any>)

Specifies the set of finalizer tasks for this task.

setIgnoreExitValue

open fun setIgnoreExitValue(ignoreExitValue: Boolean): JavaExecSpec

Sets whether a non-zero exit value is ignored, or an exception thrown.

setJvmArgs

open fun setJvmArgs(arguments: Iterable<out Any>)

open fun setJvmArgs(arguments: List<String>)

Sets the extra arguments to use to launch the JVM for the process.

setMaxHeapSize

open fun setMaxHeapSize(@Nullable heapSize: @Nullable String)

Sets the maximum heap size for the process.

setMinHeapSize

open fun setMinHeapSize(@Nullable heapSize: @Nullable String)

Sets the minimum heap size for the process.

setMustRunAfter

open fun setMustRunAfter(mustRunAfterTasks: Iterable<out Any>)

abstract fun setMustRunAfter(mustRunAfter: Iterable<out Any>)

open fun setMustRunAfter(mustRunAfterTasks: Iterable<out Any>)

Specifies the set of tasks that this task must run after.

setOnlyIf

open fun setOnlyIf(onlyIfClosure: Closure)

abstract fun setOnlyIf(onlyIfClosure: Closure<out Any>)

Execute the task only if the given closure returns true.

open fun setOnlyIf(spec: Spec<in Task>)

open fun setOnlyIf(onlyIfReason: String, spec: Spec<in Task>)

abstract fun setOnlyIf(onlyIfSpec: Spec<in Task>)

@Incubating

abstract fun setOnlyIf(onlyIfReason: String, onlyIfSpec: Spec<in Task>)

open fun setOnlyIf(spec: Spec<in Task>)

Execute the task only if the given spec is satisfied.

setProperty

open fun setProperty(name: String, value: Any)

Sets a property of this task.

setShouldRunAfter

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<out Any>)

abstract fun setShouldRunAfter(shouldRunAfter: Iterable<out Any>)

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<out Any>)

Specifies the set of tasks that this task should run after.

setStandardInput

open fun setStandardInput(inputStream: InputStream): JavaExec

Sets the standard input stream for the process executing the command.

setStandardOutput

open fun setStandardOutput(outputStream: OutputStream): JavaExec

Sets the output stream to consume standard output from the process executing the command.

setSystemProperties

open fun setSystemProperties(properties: Map<String, out @Nullable Any>)

Sets the system properties to use for the process.

setWorkingDir

open fun setWorkingDir(dir: File)

open fun setWorkingDir(dir: Any)

Sets the working directory for the process.

shouldRunAfter

open fun shouldRunAfter(paths: Array<Any>): TaskDependency

Specifies that this task should run after all of the supplied tasks.

systemProperties

open fun systemProperties(properties: Map<String, out @Nullable Any>): JavaExec

Adds some system properties to use for the process.

systemProperty

open fun systemProperty(name: String, @Nullable value: @Nullable Any): JavaExec

Adds a system property to use for the process.

usesService

open fun usesService(service: Provider<out BuildService<out Any>>)

Registers a BuildService that is used by this task so its constraint on parallel execution can be honored.

workingDir

open fun workingDir(dir: Any): JavaExec

Sets the working directory for the process.