Specifies the options to use to fork a Java process.
Type | Name and description |
---|---|
JavaForkOptions |
bootstrapClasspath(Object... classpath) Adds the given values to the end of the bootstrap classpath for the process. |
JavaForkOptions |
copyTo(JavaForkOptions options) Copies these options to the given options. |
List<String> |
getAllJvmArgs() Returns the full set of arguments to use to launch the JVM for the process. |
FileCollection |
getBootstrapClasspath() Returns the bootstrap classpath to use for the process. |
boolean |
getDebug() Returns true if debugging is enabled for the process. |
String |
getDefaultCharacterEncoding() Returns the default character encoding to use. |
boolean |
getEnableAssertions() Returns true if assertions are enabled for the process. |
List<String> |
getJvmArgs() Returns the extra arguments to use to launch the JVM for the process. |
String |
getMaxHeapSize() Returns the maximum heap size for the process, if any. |
String |
getMinHeapSize() Returns the minimum heap size for the process, if any. |
Map<String, Object> |
getSystemProperties() Returns the system properties which will be used for the process. |
JavaForkOptions |
jvmArgs(Iterable<?> arguments) Adds some arguments to use to launch the JVM for the process. |
JavaForkOptions |
jvmArgs(Object... arguments) Adds some arguments to use to launch the JVM for the process. |
void |
setAllJvmArgs(Iterable<?> arguments) Sets the full set of arguments to use to launch the JVM for the process. |
void |
setBootstrapClasspath(FileCollection classpath) Sets the bootstrap classpath to use for the process. |
void |
setDebug(boolean enabled) Enable or disable debugging for the process. |
void |
setDefaultCharacterEncoding(String defaultCharacterEncoding) Sets the default character encoding to use. |
void |
setEnableAssertions(boolean enabled) Enable or disable assertions for the process. |
void |
setJvmArgs(Iterable<?> arguments) Sets the extra arguments to use to launch the JVM for the process. |
void |
setMaxHeapSize(String heapSize) Sets the maximum heap size for the process. |
void |
setMinHeapSize(String heapSize) Sets the minimum heap size for the process. |
void |
setSystemProperties(Map<String, ?> properties) Sets the system properties to use for the process. |
JavaForkOptions |
systemProperties(Map<String, ?> properties) Adds some system properties to use for the process. |
JavaForkOptions |
systemProperty(String name, Object value) Adds a system property to use for the process. |
Methods inherited from class | Name |
---|---|
interface ProcessForkOptions |
copyTo, environment, environment, executable, getEnvironment, getExecutable, getWorkingDir, setEnvironment, setExecutable, setWorkingDir, workingDir |
Adds the given values to the end of the bootstrap classpath for the process.
classpath
- The classpath.Copies these options to the given options.
options
- The target options.Returns 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 bootstrap classpath to use for the process. The default bootstrap classpath for the JVM is used when this classpath is empty.
Returns true if debugging is enabled for the process. When enabled, the process is started suspended and listening on port 5005.
Returns the default character encoding to use.
Returns true if assertions are enabled for the process.
Returns 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 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.
arguments
- The arguments. Must not be null.Adds some arguments to use to launch the JVM for the process.
arguments
- The arguments.Sets 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.
arguments
- The arguments. Must not be null.Sets the bootstrap classpath to use for the process. Set to an empty classpath to use the default bootstrap classpath for the specified JVM.
classpath
- The classpath. Must not be null. Can be empty.Enable or disable debugging for the process. When enabled, the process is started suspended and listening on port 5005.
enabled
- true to enable debugging, false to disable. Sets the default character encoding to use.
Note: Many JVM implementations support the setting of this attribute via system property on startup (namely, the file.encoding
property). For JVMs
where this is the case, setting the file.encoding
property via setSystemProperties(java.util.Map) or similar will have no effect as
this value will be overridden by the value specified by getDefaultCharacterEncoding().
defaultCharacterEncoding
- The default character encoding. Use null to use this JVM's default charsetEnable or disable assertions for the process.
enabled
- true to enable assertions, false to disable.Sets the extra arguments to use to launch the JVM for the process. System properties and minimum/maximum heap size are updated.
arguments
- The arguments. Must not be null.Sets the maximum heap size for the process.
heapSize
- The heap size. Use null for the default maximum heap size.Sets the minimum heap size for the process.
heapSize
- The minimum heap size. Use null for the default minimum heap size.Sets the system properties to use for the process.
properties
- The system properties. Must not be null.Adds some system properties to use for the process.
properties
- The system properties. Must not be null.Adds a system property to use for the process.
name
- The name of the propertyvalue
- The value for the property. May be null.