org.gradle.process.internal

Class DefaultJavaForkOptions

java.lang.Object

org.gradle.process.internal.DefaultProcessForkOptions

org.gradle.process.internal.DefaultJavaForkOptions

All Implemented Interfaces:

JavaForkOptions, ProcessForkOptions

public class DefaultJavaForkOptions
extends DefaultProcessForkOptions
implements JavaForkOptions

Constructor Summary

Constructors

Constructor and Description
DefaultJavaForkOptions(FileResolver resolver)
DefaultJavaForkOptions(FileResolver resolver, Jvm jvm)

Method Summary

Methods

Modifier and Type	Method and Description
JavaForkOptions	bootstrapClasspath(Object... classpath) Adds the given values to the end of the bootstrap classpath for the process.
JavaForkOptions	copyTo(JavaForkOptions target) 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 org.gradle.process.internal.DefaultProcessForkOptions

copyTo, environment, environment, executable, getActualEnvironment, getEnvironment, getExecutable, getResolver, getWorkingDir, setEnvironment, setExecutable, setWorkingDir, workingDir

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gradle.process.ProcessForkOptions

copyTo, environment, environment, executable, getEnvironment, getExecutable, getWorkingDir, setEnvironment, setExecutable, setWorkingDir, workingDir

Constructor Detail

DefaultJavaForkOptions

public DefaultJavaForkOptions(FileResolver resolver)

DefaultJavaForkOptions

public DefaultJavaForkOptions(FileResolver resolver,
                      Jvm jvm)

Method Detail

getAllJvmArgs

public List<String> getAllJvmArgs()

Description copied from interface: JavaForkOptions

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.

Specified by:

getAllJvmArgs in interface JavaForkOptions

Returns:

The arguments. Returns an empty list if there are no arguments.

setAllJvmArgs

public void setAllJvmArgs(Iterable<?> arguments)

Description copied from interface: JavaForkOptions

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.

Specified by:

setAllJvmArgs in interface JavaForkOptions

Parameters:

arguments - The arguments. Must not be null.

getJvmArgs

public List<String> getJvmArgs()

Description copied from interface: JavaForkOptions

Returns the extra arguments to use to launch the JVM for the process. Does not include system properties and the minimum/maximum heap size.

Specified by:

getJvmArgs in interface JavaForkOptions

Returns:

The arguments. Returns an empty list if there are no arguments.

setJvmArgs

public void setJvmArgs(Iterable<?> arguments)

Description copied from interface: JavaForkOptions

Sets the extra arguments to use to launch the JVM for the process. System properties and minimum/maximum heap size are updated.

Specified by:

setJvmArgs in interface JavaForkOptions

Parameters:

arguments - The arguments. Must not be null.

jvmArgs

public JavaForkOptions jvmArgs(Iterable<?> arguments)

Description copied from interface: JavaForkOptions

Adds some arguments to use to launch the JVM for the process.

Specified by:

jvmArgs in interface JavaForkOptions

Parameters:

arguments - The arguments. Must not be null.

Returns:

this

jvmArgs

public JavaForkOptions jvmArgs(Object... arguments)

Description copied from interface: JavaForkOptions

Adds some arguments to use to launch the JVM for the process.

Specified by:

jvmArgs in interface JavaForkOptions

Parameters:

arguments - The arguments.

Returns:

this

getSystemProperties

public Map<String,Object> getSystemProperties()

Description copied from interface: JavaForkOptions

Returns the system properties which will be used for the process.

Specified by:

getSystemProperties in interface JavaForkOptions

Returns:

The system properties. Returns an empty map when there are no system properties.

setSystemProperties

public void setSystemProperties(Map<String,?> properties)

Description copied from interface: JavaForkOptions

Sets the system properties to use for the process.

Specified by:

setSystemProperties in interface JavaForkOptions

Parameters:

properties - The system properties. Must not be null.

systemProperties

public JavaForkOptions systemProperties(Map<String,?> properties)

Description copied from interface: JavaForkOptions

Adds some system properties to use for the process.

Specified by:

systemProperties in interface JavaForkOptions

Parameters:

properties - The system properties. Must not be null.

Returns:

this

systemProperty

public JavaForkOptions systemProperty(String name,
                             Object value)

Description copied from interface: JavaForkOptions

Adds a system property to use for the process.

Specified by:

systemProperty in interface JavaForkOptions

Parameters:

name - The name of the property

value - The value for the property. May be null.

Returns:

this

getBootstrapClasspath

public FileCollection getBootstrapClasspath()

Description copied from interface: JavaForkOptions

Returns the bootstrap classpath to use for the process. The default bootstrap classpath for the JVM is used when this classpath is empty.

Specified by:

getBootstrapClasspath in interface JavaForkOptions

Returns:

The bootstrap classpath. Never returns null.

setBootstrapClasspath

public void setBootstrapClasspath(FileCollection classpath)

Description copied from interface: JavaForkOptions

Sets the bootstrap classpath to use for the process. Set to an empty classpath to use the default bootstrap classpath for the specified JVM.

Specified by:

setBootstrapClasspath in interface JavaForkOptions

Parameters:

classpath - The classpath. Must not be null. Can be empty.

bootstrapClasspath

public JavaForkOptions bootstrapClasspath(Object... classpath)

Description copied from interface: JavaForkOptions

Adds the given values to the end of the bootstrap classpath for the process.

Specified by:

bootstrapClasspath in interface JavaForkOptions

Parameters:

classpath - The classpath.

Returns:

this

getMinHeapSize

public String getMinHeapSize()

Description copied from interface: JavaForkOptions

Returns the minimum heap size for the process, if any.

Specified by:

getMinHeapSize in interface JavaForkOptions

Returns:

The minimum heap size. Returns null if the default minimum heap size should be used.

setMinHeapSize

public void setMinHeapSize(String heapSize)

Description copied from interface: JavaForkOptions

Sets the minimum heap size for the process.

Specified by:

setMinHeapSize in interface JavaForkOptions

Parameters:

heapSize - The minimum heap size. Use null for the default minimum heap size.

getMaxHeapSize

public String getMaxHeapSize()

Description copied from interface: JavaForkOptions

Returns the maximum heap size for the process, if any.

Specified by:

getMaxHeapSize in interface JavaForkOptions

Returns:

The maximum heap size. Returns null if the default maximum heap size should be used.

setMaxHeapSize

public void setMaxHeapSize(String heapSize)

Description copied from interface: JavaForkOptions

Sets the maximum heap size for the process.

Specified by:

setMaxHeapSize in interface JavaForkOptions

Parameters:

heapSize - The heap size. Use null for the default maximum heap size.

getDefaultCharacterEncoding

public String getDefaultCharacterEncoding()

Description copied from interface: JavaForkOptions

Returns the default character encoding to use.

Specified by:

getDefaultCharacterEncoding in interface JavaForkOptions

Returns:

The default character encoding. Returns null if the default character encoding of this JVM should be used.

setDefaultCharacterEncoding

public void setDefaultCharacterEncoding(String defaultCharacterEncoding)

Description copied from interface: JavaForkOptions

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 JavaForkOptions.setSystemProperties(java.util.Map) or similar will have no effect as this value will be overridden by the value specified by JavaForkOptions.getDefaultCharacterEncoding().

Specified by:

setDefaultCharacterEncoding in interface JavaForkOptions

Parameters:

defaultCharacterEncoding - The default character encoding. Use null to use this JVM's default charset

getEnableAssertions

public boolean getEnableAssertions()

Description copied from interface: JavaForkOptions

Returns true if assertions are enabled for the process.

Specified by:

getEnableAssertions in interface JavaForkOptions

Returns:

true if assertions are enabled, false if disabled

setEnableAssertions

public void setEnableAssertions(boolean enabled)

Description copied from interface: JavaForkOptions

Enable or disable assertions for the process.

Specified by:

setEnableAssertions in interface JavaForkOptions

Parameters:

enabled - true to enable assertions, false to disable.

getDebug

public boolean getDebug()

Description copied from interface: JavaForkOptions

Returns true if debugging is enabled for the process. When enabled, the process is started suspended and listening on port 5005.

Specified by:

getDebug in interface JavaForkOptions

Returns:

true when debugging is enabled, false to disable.

setDebug

public void setDebug(boolean enabled)

Description copied from interface: JavaForkOptions

Enable or disable debugging for the process. When enabled, the process is started suspended and listening on port 5005.

Specified by:

setDebug in interface JavaForkOptions

Parameters:

enabled - true to enable debugging, false to disable.

copyTo

public JavaForkOptions copyTo(JavaForkOptions target)

Description copied from interface: JavaForkOptions

Copies these options to the given options.

Specified by:

copyTo in interface JavaForkOptions

Parameters:

target - The target options.

Returns:

this