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: ConventionMapping

description

open var description: String

enabled

open var enabled: Boolean

extra

val ExtensionAware.extra: ExtraPropertiesExtension

The extra properties extension in this object's extension container.

group

open var group: String

impliesSubProjects

open var impliesSubProjects: Boolean

javaLauncher

val javaLauncher: Property<JavaLauncher>

mainClass

val mainClass: Property<String>

mainModule

val mainModule: Property<String>

modularity

val modularity: ModularitySpec

state

val state: TaskStateInternal

TASK_ACTION

val TASK_ACTION: String = "action"

TASK_CONSTRUCTOR_ARGS

val TASK_CONSTRUCTOR_ARGS: String = "constructorArgs"

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

bootstrapClasspath

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

classpath

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

compareTo

open fun compareTo(otherTask: Task): Int

configure

open fun configure(closure: Closure): Task

abstract fun configure(cl: Closure): T

configure

inline fun <T : Any> ExtensionAware.configure(noinline configuration: T.() -> Unit)

Executes the given configuration block against the extension of the specified type.

conventionMapping

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

copyTo

open fun copyTo(options: JavaForkOptions): JavaExec

open fun copyTo(target: ProcessForkOptions): JavaExec

debugOptions

open fun debugOptions(action: Action<JavaDebugOptions>)

dependsOn

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

doFirst

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

doLast

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

doNotTrackState

open fun doNotTrackState(reasonNotToTrackState: String)

environment

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

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

environment

inline fun JavaExec.environment(vararg environmentVariables: Pair<String, Any?>): JavaExec

Kotlin extension function for org.gradle.api.tasks.JavaExec.environment.

inline fun ProcessForkOptions.environment(vararg environmentVariables: Pair<String, Any?>): ProcessForkOptions

Kotlin extension function for org.gradle.process.ProcessForkOptions.environment.

exec

open fun exec()

executable

open fun executable(executable: Any): JavaExec

finalizedBy

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

getActions

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

getAllJvmArgs

open fun getAllJvmArgs(): List<String>

getAnt

open fun getAnt(): AntBuilder

getArgs

open fun getArgs(): List<String>

getArgumentProviders

open fun getArgumentProviders(): List<CommandLineArgumentProvider>

getAsDynamicObject

open fun getAsDynamicObject(): DynamicObject

getBootstrapClasspath

open fun getBootstrapClasspath(): FileCollection

getClasspath

open fun getClasspath(): FileCollection

getCommandLine

@Internal

open fun getCommandLine(): List<String>

getConvention

open fun getConvention(): Convention

getDebug

open fun getDebug(): Boolean

getDebugOptions

open fun getDebugOptions(): JavaDebugOptions

getDefaultCharacterEncoding

open fun getDefaultCharacterEncoding(): String

getDependsOn

open fun getDependsOn(): Set<Any>

getDestroyables

open fun getDestroyables(): TaskDestroyables

getDidWork

open fun getDidWork(): Boolean

getEnableAssertions

open fun getEnableAssertions(): Boolean

getEnvironment

@Internal

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

getErrorOutput

@Internal

open fun getErrorOutput(): OutputStream

getExecutable

@Internal(value = "covered by getJavaVersion")

@Nullable

open fun getExecutable(): String

getExecutionResult

@Internal

open fun getExecutionResult(): Provider<ExecResult>

Returns the result for the command run by this task.

getExtensions

open fun getExtensions(): ExtensionContainer

getFinalizedBy

open fun getFinalizedBy(): TaskDependency

getIdentityPath

open fun getIdentityPath(): Path

getInputs

open fun getInputs(): TaskInputsInternal

abstract fun getInputs(): TaskInputs

getJavaVersion

@Input

open fun getJavaVersion(): JavaVersion

Returns the version of the Java executable specified by getJavaLauncher.

getJvmArgs

open fun getJvmArgs(): List<String>

getJvmArgumentProviders

open fun getJvmArgumentProviders(): List<CommandLineArgumentProvider>

getJvmArguments

open fun getJvmArguments(): ListProperty<String>

getLifecycleDependencies

open fun getLifecycleDependencies(): TaskDependencyInternal

abstract fun getLifecycleDependencies(): TaskDependency

getLocalState

open fun getLocalState(): TaskLocalState

getLogger

open fun getLogger(): Logger

getLogging

open fun getLogging(): LoggingManager

getMainClass

abstract fun getMainClass(): Property<String>

getMainModule

abstract fun getMainModule(): Property<String>

getMaxHeapSize

open fun getMaxHeapSize(): String

getMinHeapSize

open fun getMinHeapSize(): String

getModularity

abstract fun getModularity(): ModularitySpec

getMustRunAfter

open fun getMustRunAfter(): TaskDependency

getName

open fun getName(): String

getOnlyIf

open fun getOnlyIf(): Spec<in TaskInternal>

getOutputs

open fun getOutputs(): TaskOutputsInternal

abstract fun getOutputs(): TaskOutputs

getPath

open fun getPath(): String

getProject

open fun getProject(): Project

getReasonNotToTrackState

open fun getReasonNotToTrackState(): Optional<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

getStandardInput

@Internal

open fun getStandardInput(): InputStream

getStandardOutput

@Internal

open fun getStandardOutput(): OutputStream

getStandardOutputCapture

open fun getStandardOutputCapture(): StandardOutputCapture

getState

abstract fun getState(): TaskState

getSystemProperties

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

getTaskActions

open fun getTaskActions(): List<InputChangesAwareTaskAction>

getTaskDependencies

open fun getTaskDependencies(): TaskDependencyInternal

abstract fun getTaskDependencies(): TaskDependency

getTaskIdentity

open fun getTaskIdentity(): TaskIdentity<out Any>

getTemporaryDir

open fun getTemporaryDir(): File

getTemporaryDirFactory

open fun getTemporaryDirFactory(): Factory<File>

getWorkingDir

@Internal

open fun getWorkingDir(): File

hasProperty

open fun hasProperty(propertyName: String): Boolean

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

jvmArgs

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

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

mustRunAfter

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

notCompatibleWithConfigurationCache

open fun notCompatibleWithConfigurationCache(reason: String)

onlyIf

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

prependParallelSafeAction

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

property

open fun property(propertyName: String): Any

setActions

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

setAllJvmArgs

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

open fun setAllJvmArgs(arguments: List<String>)

setArgs

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

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

setArgsString

open fun setArgsString(args: String): JavaExec

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

setBootstrapClasspath

open fun setBootstrapClasspath(classpath: FileCollection)

setClasspath

open fun setClasspath(classpath: FileCollection): JavaExec

setDebug

open fun setDebug(enabled: Boolean)

setDefaultCharacterEncoding

open fun setDefaultCharacterEncoding(defaultCharacterEncoding: String)

setDependsOn

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

setDidWork

open fun setDidWork(didWork: Boolean)

setEnableAssertions

open fun setEnableAssertions(enabled: Boolean)

setEnvironment

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

setEnvironment

inline fun ProcessForkOptions.setEnvironment(vararg environmentVariables: Pair<String, Any?>)

Kotlin extension function for org.gradle.process.ProcessForkOptions.setEnvironment.

setErrorOutput

open fun setErrorOutput(outputStream: OutputStream): JavaExec

setExecutable

open fun setExecutable(executable: Any)

open fun setExecutable(executable: String)

setFinalizedBy

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

setIgnoreExitValue

open fun setIgnoreExitValue(ignoreExitValue: Boolean): JavaExecSpec

setJvmArgs

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

open fun setJvmArgs(arguments: List<String>)

setMain

open fun setMain(main: String): JavaExecSpec

setMaxHeapSize

open fun setMaxHeapSize(heapSize: String)

setMinHeapSize

open fun setMinHeapSize(heapSize: String)

setMustRunAfter

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

setOnlyIf

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

setProperty

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

setShouldRunAfter

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

setStandardInput

open fun setStandardInput(inputStream: InputStream): JavaExec

setStandardOutput

open fun setStandardOutput(outputStream: OutputStream): JavaExec

setSystemProperties

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

setWorkingDir

open fun setWorkingDir(dir: File)

open fun setWorkingDir(dir: Any)

shouldRunAfter

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

systemProperties

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

systemProperties

inline fun JavaExec.systemProperties(vararg properties: Pair<String, Any?>): JavaExec

Kotlin extension function for org.gradle.api.tasks.JavaExec.systemProperties.

inline fun JavaForkOptions.systemProperties(vararg properties: Pair<String, Any?>): JavaForkOptions

Kotlin extension function for org.gradle.process.JavaForkOptions.systemProperties.

systemProperty

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

the

inline fun <T : Any> ExtensionAware.the(): T

Returns the extension of the specified type.

fun <T : Any> ExtensionAware.the(extensionType: KClass<T>): T

Returns the extension of the specified extensionType.

usesService

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

workingDir

open fun workingDir(dir: Any): JavaExec