gradle/org.gradle.process/JavaExecSpec

JavaExecSpec

interface JavaExecSpec : JavaForkOptions, BaseExecSpec(source)

Specifies the options for executing a Java application.

Inheritors

Functions

Link copied to clipboard
abstract fun args(args: Iterable<out Any>): JavaExecSpec
abstract fun args(args: Array<Any>): JavaExecSpec
Adds args for the main class to be executed.
Link copied to clipboard
abstract fun bootstrapClasspath(classpath: Array<Any>): JavaForkOptions
Link copied to clipboard
abstract fun classpath(paths: Array<Any>): JavaExecSpec
Adds elements to the classpath for executing the main class.
Link copied to clipboard
abstract fun copyTo(options: JavaForkOptions): JavaForkOptions
abstract fun copyTo(options: ProcessForkOptions): ProcessForkOptions
Link copied to clipboard
abstract fun debugOptions(action: Action<JavaDebugOptions>)
Link copied to clipboard
abstract fun environment(environmentVariables: Map<String, out Any>): ProcessForkOptions
Link copied to clipboard
inline fun ProcessForkOptions.environment(vararg environmentVariables: Pair<String, Any?>): ProcessForkOptions

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

Link copied to clipboard
abstract fun executable(executable: Any): ProcessForkOptions
Link copied to clipboard
abstract fun getAllJvmArgs(): List<String>
Link copied to clipboard
@Nullable
@Optional
@Input
abstract fun getArgs(): List<String>
Returns the arguments passed to the main class to be executed.
Link copied to clipboard
abstract fun getArgumentProviders(): List<CommandLineArgumentProvider>
Argument providers for the application.
Link copied to clipboard
Link copied to clipboard
@Classpath
abstract fun getClasspath(): FileCollection
Returns the classpath for executing the main class.
Link copied to clipboard
abstract fun getCommandLine(): List<String>
Link copied to clipboard
abstract fun getDebug(): Boolean
Link copied to clipboard
abstract fun getDebugOptions(): JavaDebugOptions
Link copied to clipboard
abstract fun getDefaultCharacterEncoding(): String
Link copied to clipboard
abstract fun getEnableAssertions(): Boolean
Link copied to clipboard
abstract fun getEnvironment(): Map<String, Any>
Link copied to clipboard
abstract fun getErrorOutput(): OutputStream
Link copied to clipboard
abstract fun getExecutable(): String
Link copied to clipboard
abstract fun getJvmArgs(): List<String>
Link copied to clipboard
Link copied to clipboard
@Incubating
@Optional
@Internal
abstract fun getJvmArguments(): ListProperty<String>
Extra JVM arguments to be to use to launch the JVM for the process.
Link copied to clipboard
@Optional
@Input
abstract fun getMainClass(): Property<String>
The fully qualified name of the Main class to be executed.
Link copied to clipboard
@Optional
@Input
abstract fun getMainModule(): Property<String>
The name of the main module to be executed if the application should run as a Java module.
Link copied to clipboard
abstract fun getMaxHeapSize(): String
Link copied to clipboard
abstract fun getMinHeapSize(): String
Link copied to clipboard
abstract fun getModularity(): ModularitySpec
Returns the module path handling for executing the main class.
Link copied to clipboard
abstract fun getStandardInput(): InputStream
Link copied to clipboard
abstract fun getStandardOutput(): OutputStream
Link copied to clipboard
abstract fun getSystemProperties(): Map<String, Any>
Link copied to clipboard
abstract fun getWorkingDir(): File
Link copied to clipboard
abstract fun isIgnoreExitValue(): Boolean
Link copied to clipboard
abstract fun jvmArgs(arguments: Iterable<out Any>): JavaForkOptions
Link copied to clipboard
abstract fun setAllJvmArgs(arguments: List<String>)
Link copied to clipboard
abstract fun setArgs(@Nullable args: Iterable<out Any>): JavaExecSpec
abstract fun setArgs(@Nullable args: List<String>): JavaExecSpec
Sets the args for the main class to be executed.
Link copied to clipboard
abstract fun setBootstrapClasspath(classpath: FileCollection)
Link copied to clipboard
abstract fun setClasspath(classpath: FileCollection): JavaExecSpec
Sets the classpath for executing the main class.
Link copied to clipboard
abstract fun setDebug(enabled: Boolean)
Link copied to clipboard
abstract fun setDefaultCharacterEncoding(defaultCharacterEncoding: String)
Link copied to clipboard
abstract fun setEnableAssertions(enabled: Boolean)
Link copied to clipboard
abstract fun setEnvironment(environmentVariables: Map<String, out Any>)
Link copied to clipboard
inline fun ProcessForkOptions.setEnvironment(vararg environmentVariables: Pair<String, Any?>)

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

Link copied to clipboard
abstract fun setErrorOutput(outputStream: OutputStream): BaseExecSpec
Link copied to clipboard
abstract fun setExecutable(executable: String)
Link copied to clipboard
abstract fun setIgnoreExitValue(ignoreExitValue: Boolean): BaseExecSpec
Link copied to clipboard
abstract fun setJvmArgs(arguments: List<String>)
Link copied to clipboard
@ReplacedBy(value = "mainClass")
open fun setMain(@Nullable main: String): JavaExecSpec
Sets the fully qualified name of the main class to be executed.
Link copied to clipboard
abstract fun setMaxHeapSize(heapSize: String)
Link copied to clipboard
abstract fun setMinHeapSize(heapSize: String)
Link copied to clipboard
abstract fun setStandardInput(inputStream: InputStream): BaseExecSpec
Link copied to clipboard
abstract fun setStandardOutput(outputStream: OutputStream): BaseExecSpec
Link copied to clipboard
abstract fun setSystemProperties(properties: Map<String, out Any>)
Link copied to clipboard
abstract fun setWorkingDir(dir: File)
Link copied to clipboard
abstract fun systemProperties(properties: Map<String, out Any>): JavaForkOptions
Link copied to clipboard
inline fun JavaForkOptions.systemProperties(vararg properties: Pair<String, Any?>): JavaForkOptions

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

Link copied to clipboard
abstract fun systemProperty(name: String, value: Any): JavaForkOptions
Link copied to clipboard
abstract fun workingDir(dir: Any): ProcessForkOptions