api / org.gradle.api.tasks / JavaExec

JavaExec

open class JavaExec : ConventionTask, JavaExecSpec

Executes a Java application in a child process.

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

 apply plugin: 'java' task runApp(type: JavaExec) { classpath = sourceSets.main.runtimeClasspath main = 'package.Main' // 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 

Constructors

<init>

JavaExec()

Functions

args

open fun args(vararg args: Any): JavaExec
open fun args(args: MutableIterable<*>): JavaExecSpec

{@inheritDoc}

bootstrapClasspath

open fun bootstrapClasspath(vararg classpath: Any): JavaExec

{@inheritDoc}

classpath

open fun classpath(vararg paths: Any): JavaExec

{@inheritDoc}

copyTo

open fun copyTo(options: JavaForkOptions): JavaExec
open fun copyTo(target: ProcessForkOptions): JavaExec

{@inheritDoc}

environment

open fun environment(name: String, value: Any): JavaExec
open fun environment(environmentVariables: MutableMap<String, *>): JavaExec

{@inheritDoc}

exec

open fun exec(): Unit

executable

open fun executable(executable: Any): JavaExec

{@inheritDoc}

getAllJvmArgs

open fun getAllJvmArgs(): MutableList<String>

{@inheritDoc}

getArgs

open fun getArgs(): MutableList<String>

{@inheritDoc}

getArgumentProviders

open fun getArgumentProviders(): MutableList<CommandLineArgumentProvider>

{@inheritDoc}

getBootstrapClasspath

open fun getBootstrapClasspath(): FileCollection

{@inheritDoc}

getClasspath

open fun getClasspath(): FileCollection

{@inheritDoc}

getCommandLine

open fun getCommandLine(): MutableList<String>

{@inheritDoc}

getDebug

open fun getDebug(): Boolean

{@inheritDoc}

getDefaultCharacterEncoding

open fun getDefaultCharacterEncoding(): String

{@inheritDoc}

getEnableAssertions

open fun getEnableAssertions(): Boolean

{@inheritDoc}

getEnvironment

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

{@inheritDoc}

getErrorOutput

open fun getErrorOutput(): OutputStream

{@inheritDoc}

getExecutable

open fun getExecutable(): String

{@inheritDoc}

getJvmArgs

open fun getJvmArgs(): MutableList<String>

{@inheritDoc}

getJvmArgumentProviders

open fun getJvmArgumentProviders(): MutableList<CommandLineArgumentProvider>

{@inheritDoc}

getMain

open fun getMain(): String

{@inheritDoc}

getMaxHeapSize

open fun getMaxHeapSize(): String

{@inheritDoc}

getMinHeapSize

open fun getMinHeapSize(): String

{@inheritDoc}

getStandardInput

open fun getStandardInput(): InputStream

{@inheritDoc}

getStandardOutput

open fun getStandardOutput(): OutputStream

{@inheritDoc}

getSystemProperties

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

{@inheritDoc}

getWorkingDir

open fun getWorkingDir(): File

{@inheritDoc}

isIgnoreExitValue

open fun isIgnoreExitValue(): Boolean

{@inheritDoc}

jvmArgs

open fun jvmArgs(arguments: MutableIterable<*>): JavaExec
open fun jvmArgs(vararg arguments: Any): JavaExec

{@inheritDoc}

setAllJvmArgs

open fun setAllJvmArgs(arguments: MutableList<String>): Unit
open fun setAllJvmArgs(arguments: MutableIterable<*>): Unit

{@inheritDoc}

setArgs

open fun setArgs(applicationArgs: MutableList<String>): JavaExec
open fun setArgs(applicationArgs: MutableIterable<*>): JavaExec

{@inheritDoc}

setArgsString

open fun setArgsString(args: String): JavaExec

Command line arguments passed to the main class.

setBootstrapClasspath

open fun setBootstrapClasspath(classpath: FileCollection): Unit

{@inheritDoc}

setClasspath

open fun setClasspath(classpath: FileCollection): JavaExec

{@inheritDoc}

setDebug

open fun setDebug(enabled: Boolean): Unit

{@inheritDoc}

setDefaultCharacterEncoding

open fun setDefaultCharacterEncoding(defaultCharacterEncoding: String): Unit

{@inheritDoc}

setEnableAssertions

open fun setEnableAssertions(enabled: Boolean): Unit

{@inheritDoc}

setEnvironment

open fun setEnvironment(environmentVariables: MutableMap<String, *>): Unit

{@inheritDoc}

setErrorOutput

open fun setErrorOutput(outputStream: OutputStream): JavaExec

{@inheritDoc}

setExecutable

open fun setExecutable(executable: String): Unit
open fun setExecutable(executable: Any): Unit

{@inheritDoc}

setIgnoreExitValue

open fun setIgnoreExitValue(ignoreExitValue: Boolean): JavaExecSpec

{@inheritDoc}

setJvmArgs

open fun setJvmArgs(arguments: MutableList<String>): Unit
open fun setJvmArgs(arguments: MutableIterable<*>): Unit

{@inheritDoc}

setMain

open fun setMain(mainClassName: String): JavaExec

{@inheritDoc}

setMaxHeapSize

open fun setMaxHeapSize(heapSize: String): Unit

{@inheritDoc}

setMinHeapSize

open fun setMinHeapSize(heapSize: String): Unit

{@inheritDoc}

setStandardInput

open fun setStandardInput(inputStream: InputStream): JavaExec

{@inheritDoc}

setStandardOutput

open fun setStandardOutput(outputStream: OutputStream): JavaExec

{@inheritDoc}

setSystemProperties

open fun setSystemProperties(properties: MutableMap<String, *>): Unit

{@inheritDoc}

setWorkingDir

open fun setWorkingDir(dir: File): Unit
open fun setWorkingDir(dir: Any): Unit

{@inheritDoc}

systemProperties

open fun systemProperties(properties: MutableMap<String, *>): JavaExec

{@inheritDoc}

systemProperty

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

{@inheritDoc}

workingDir

open fun workingDir(dir: Any): JavaExec

{@inheritDoc}

Inheritors

RhinoShellExec

open class RhinoShellExec : JavaExec