Package org.gradle.process
Interface JavaForkOptions
- All Superinterfaces:
- ProcessForkOptions
- All Known Subinterfaces:
- JavaExecSpec
Specifies the options to use to fork a Java process.
- 
Method SummaryModifier and TypeMethodDescriptionbootstrapClasspath(Object... classpath) Adds the given values to the end of the bootstrap classpath for the process.copyTo(JavaForkOptions options) Copies these options to the given options.voiddebugOptions(Action<JavaDebugOptions> action) Configures Java Debug Wire Protocol properties for the process.Returns the full set of arguments to use to launch the JVM for the process.Returns the bootstrap classpath to use for the process.booleangetDebug()Determines whether debugging is enabled for the test process.Returns the Java Debug Wire Protocol properties for the process.Returns the default character encoding to use.booleanReturns true if assertions are enabled for the process.Returns the extra arguments to use to launch the JVM for the process.Command line argument providers for the java process to fork.Returns the maximum heap size for the process, if any.Returns the minimum heap size for the process, if any.Returns the system properties which will be used for the process.Adds some arguments to use to launch the JVM for the process.Adds some arguments to use to launch the JVM for the process.voidsetAllJvmArgs(Iterable<?> arguments) Sets the full set of arguments to use to launch the JVM for the process.voidsetAllJvmArgs(List<String> arguments) Sets the full set of arguments to use to launch the JVM for the process.voidsetBootstrapClasspath(FileCollection classpath) Sets the bootstrap classpath to use for the process.voidsetDebug(boolean enabled) Enable or disable debugging for the process.voidsetDefaultCharacterEncoding(String defaultCharacterEncoding) Sets the default character encoding to use.voidsetEnableAssertions(boolean enabled) Enable or disable assertions for the process.voidsetJvmArgs(Iterable<?> arguments) Sets the extra arguments to use to launch the JVM for the process.voidsetJvmArgs(List<String> arguments) Sets the extra arguments to use to launch the JVM for the process.voidsetMaxHeapSize(String heapSize) Sets the maximum heap size for the process.voidsetMinHeapSize(String heapSize) Sets the minimum heap size for the process.voidsetSystemProperties(Map<String, ?> properties) Sets the system properties to use for the process.systemProperties(Map<String, ?> properties) Adds some system properties to use for the process.systemProperty(String name, Object value) Adds a system property to use for the process.Methods inherited from interface org.gradle.process.ProcessForkOptionscopyTo, environment, environment, executable, getEnvironment, getExecutable, getWorkingDir, setEnvironment, setExecutable, setExecutable, setWorkingDir, setWorkingDir, workingDir
- 
Method Details- 
getSystemPropertiesReturns the system properties which will be used for the process.- Returns:
- The system properties. Returns an empty map when there are no system properties.
 
- 
setSystemPropertiesSets the system properties to use for the process.- Parameters:
- properties- The system properties. Must not be null.
 
- 
systemPropertiesAdds some system properties to use for the process.- Parameters:
- properties- The system properties. Must not be null.
- Returns:
- this
 
- 
systemPropertyAdds a system property to use for the process.- Parameters:
- name- The name of the property
- value- The value for the property. May be null.
- Returns:
- this
 
- 
getDefaultCharacterEncodingReturns the default character encoding to use.- Returns:
- The default character encoding. Returns null if the default character encoding of this JVMshould be used.
 
- 
setDefaultCharacterEncodingSets the default character encoding to use. Note: Many JVM implementations support the setting of this attribute via system property on startup (namely, thefile.encodingproperty). For JVMs where this is the case, setting thefile.encodingproperty viasetSystemProperties(java.util.Map)or similar will have no effect as this value will be overridden by the value specified bygetDefaultCharacterEncoding().- Parameters:
- defaultCharacterEncoding- The default character encoding. Use null to use- this JVM's default charset
 
- 
getMinHeapSizeReturns the minimum heap size for the process, if any.- Returns:
- The minimum heap size. Returns null if the default minimum heap size should be used.
 
- 
setMinHeapSizeSets the minimum heap size for the process. Supports the units megabytes (e.g. "512m") and gigabytes (e.g. "1g").- Parameters:
- heapSize- The minimum heap size. Use null for the default minimum heap size.
 
- 
getMaxHeapSizeReturns the maximum heap size for the process, if any.- Returns:
- The maximum heap size. Returns null if the default maximum heap size should be used.
 
- 
setMaxHeapSizeSets the maximum heap size for the process. Supports the units megabytes (e.g. "512m") and gigabytes (e.g. "1g").- Parameters:
- heapSize- The heap size. Use null for the default maximum heap size.
 
- 
getJvmArgsReturns the extra arguments to use to launch the JVM for the process. Does not include system properties and the minimum/maximum heap size.- Returns:
- The immutable list of arguments. Returns an empty list if there are no arguments.
 
- 
setJvmArgsSets the extra arguments to use to launch the JVM for the process. System properties and minimum/maximum heap size are updated.- Parameters:
- arguments- The arguments. Must not be null.
- Since:
- 4.0
 
- 
setJvmArgsSets the extra arguments to use to launch the JVM for the process. System properties and minimum/maximum heap size are updated.- Parameters:
- arguments- The arguments. Must not be null.
 
- 
jvmArgsAdds some arguments to use to launch the JVM for the process.- Parameters:
- arguments- The arguments. Must not be null.
- Returns:
- this
 
- 
jvmArgsAdds some arguments to use to launch the JVM for the process.- Parameters:
- arguments- The arguments.
- Returns:
- this
 
- 
getJvmArgumentProvidersList<CommandLineArgumentProvider> getJvmArgumentProviders()Command line argument providers for the java process to fork.- Since:
- 4.6
 
- 
getBootstrapClasspathReturns the bootstrap classpath to use for the process. The default bootstrap classpath for the JVM is used when this classpath is empty.- Returns:
- The bootstrap classpath. Never returns null.
 
- 
setBootstrapClasspathSets the bootstrap classpath to use for the process. Set to an empty classpath to use the default bootstrap classpath for the specified JVM.- Parameters:
- classpath- The classpath. Must not be null. Can be empty.
 
- 
bootstrapClasspathAdds the given values to the end of the bootstrap classpath for the process.- Parameters:
- classpath- The classpath.
- Returns:
- this
 
- 
getEnableAssertionsReturns true if assertions are enabled for the process.- Returns:
- true if assertions are enabled, false if disabled
 
- 
setEnableAssertionsvoid setEnableAssertions(boolean enabled) Enable or disable assertions for the process.- Parameters:
- enabled- true to enable assertions, false to disable.
 
- 
getDebugDetermines whether debugging is enabled for the test process. When enabled —debug = true— the process is started in a suspended state, listening on port 5005. You should disable parallel test execution when debugging and you will need to reattach the debugger occasionally if you use a non-zero value forTest.getForkEvery().Since Gradle 5.6, you can configure the port and other Java debug properties via debugOptions(Action).- Returns:
- true when debugging is enabled, false to disable.
 
- 
setDebugvoid setDebug(boolean enabled) Enable or disable debugging for the process. When enabled, the process is started suspended and listening on port 5005.The debug properties (e.g. the port number) can be configured in debugOptions(Action).- Parameters:
- enabled- true to enable debugging, false to disable.
 
- 
getDebugOptionsJavaDebugOptions getDebugOptions()Returns the Java Debug Wire Protocol properties for the process. If enabled then the-agentlib:jdwp=...will be appended to the JVM arguments with the configuration from the parameter.- Since:
- 5.6
 
- 
debugOptionsConfigures Java Debug Wire Protocol properties for the process. IfsetDebug(boolean)is enabled then the-agentlib:jdwp=...will be appended to the JVM arguments with the configuration from the parameter.- Parameters:
- action- the Java debug configuration
- Since:
- 5.6
 
- 
getAllJvmArgsReturns the full set of arguments to use to launch the JVM for the process. This includes arguments to define system properties, the minimum/maximum heap size, and the bootstrap classpath.- Returns:
- The immutable list of arguments. Returns an empty list if there are no arguments.
 
- 
setAllJvmArgsSets the full set of arguments to use to launch the JVM for the process. Overwrites any previously set system properties, minimum/maximum heap size, assertions, and bootstrap classpath.- Parameters:
- arguments- The arguments. Must not be null.
- Since:
- 4.0
 
- 
setAllJvmArgsSets the full set of arguments to use to launch the JVM for the process. Overwrites any previously set system properties, minimum/maximum heap size, assertions, and bootstrap classpath.- Parameters:
- arguments- The arguments. Must not be null.
 
- 
copyToCopies these options to the given options.- Parameters:
- options- The target options.
- Returns:
- this
 
 
-