JavaForkOptions (docs 1.1.0 API)

org.ysb33r.grolifant.api.v4.JavaForkOptions

Provides a class that can be populated with various fork options for Java and which can then be used to copy to other methods in the Gradle API that provides a JavaForkOptions in the parameters.
Since:
0.7

Properties Summary

Properties
Type	Name and description
`FileCollection`	`bootstrapClasspath`
`String`	`defaultCharacterEncoding`
`java.util.Map<String, Object>`	`environment`
`String`	`executable`
`java.util.List<String>`	`jvmArgs`
`String`	`maxHeapSize`
`String`	`minHeapSize`
`java.util.Map<String, Object>`	`systemProperties`
`Object`	`workingDir`

Methods Summary

Methods
Type Params	Return 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.
	`ProcessForkOptions`	`copyTo(ProcessForkOptions options)` Copies these options to the given target options.
	`void`	`environment(java.util.Map<String, ?> environmentVariables)` Adds some environment variables to the environment for this process.
	`void`	`environment(String name, Object value)` Adds an environment variable to the environment for this process.
	`void`	`executable(Object executable)` Sets the name of the exe to use.
	`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.
	`java.util.Map<String, Object>`	`getEnvironment()` The environment variables to use for the process.
	`String`	`getExecutable()` Returns the name of the exe to use.
	`java.util.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.
	`java.util.Map<String, Object>`	`getSystemProperties()` Returns the system properties which will be used for the process.
	`Object`	`getWorkingDir()` Returns the working directory 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`	`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`	`setEnvironment(java.util.Map<String, ?> environmentVariables)` Sets the environment variable to use for the process.
	`void`	`setExecutable(Object executable)` Sets the name of the exe to use.
	`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(java.util.Map<String, ?> props)` Sets the system properties to use for the process.
	`void`	`setWorkingDir(Object dir)` Sets the working directory for the process.
	`JavaForkOptions`	`systemProperties(java.util.Map<String, ?> props)` Adds some system properties to use for the process.
	`JavaForkOptions`	`systemProperty(String name, Object value)` Adds a system property to use for the process.
	`void`	`workingDir(Object dir)` Sets the working directory for the process.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Property Detail
  - FileCollection bootstrapClasspath
  - String defaultCharacterEncoding
  - java.util.Map<String, Object> environment
  - String executable
  - java.util.List<String> jvmArgs
  - String maxHeapSize
  - String minHeapSize
  - java.util.Map<String, Object> systemProperties
  - Object workingDir
- Method Detail
  - JavaForkOptions bootstrapClasspath(Object... classpath)
    
    Adds the given values to the end of the bootstrap classpath for the process.
    Parameters:
    classpath - The classpath.
    Returns:
    this
  - JavaForkOptions copyTo(JavaForkOptions options)
    
    Copies these options to the given options.
    Parameters:
    options - The target options.
    Returns:
    The options that were passed in.
  - ProcessForkOptions copyTo(ProcessForkOptions options)
    
    Copies these options to the given target options.
    Parameters:
    options - The target options
    Returns:
    The options that were passed in
  - void environment(java.util.Map<String, ?> environmentVariables)
    
    Adds some environment variables to the environment for this process.
    Parameters:
    environmentVariables - The environment variables. Must not be null.
  - void environment(String name, Object value)
    
    Adds an environment variable to the environment for this process.
    Parameters:
    name - The name of the variable.
    value - The value for the variable. Must not be null.
  - void executable(Object executable)
    
    Sets the name of the exe to use.
    Parameters:
    executable - The exe. Must not be null.
  - FileCollection getBootstrapClasspath()
    
    Returns 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.
  - boolean getDebug()
    
    Returns true if debugging is enabled for the process. When enabled, the process is started suspended and listening on port 5005.
    Returns:
    true when debugging is enabled, false to disable.
  - String getDefaultCharacterEncoding()
    
    Returns the default character encoding to use.
    Returns:
    The default character encoding. Returns null if the java.nio.charset.Charset#defaultCharset() should be used.
  - boolean getEnableAssertions()
    
    Returns true if assertions are enabled for the process.
    Returns:
    true if assertions are enabled, false if disabled
  - java.util.Map<String, Object> getEnvironment()
    
    The environment variables to use for the process. Defaults to the environment of this process.
    Returns:
    The environment. Returns an empty map when there are no environment variables.
  - String getExecutable()
    
    Returns the name of the exe to use.
    Returns:
    The exe.
  - java.util.List<String> getJvmArgs()
    
    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 arguments. Returns an empty list if there are no arguments.
  - String getMaxHeapSize()
    
    Returns 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.
  - String getMinHeapSize()
    
    Returns 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.
  - java.util.Map<String, Object> getSystemProperties()
    
    Returns the system properties which will be used for the process.
    Returns:
    The system properties. Returns an empty map when there are no system properties.
  - Object getWorkingDir()
    
    Returns the working directory for the process. Defaults to the project directory.
    Returns:
    The working directory.
  - JavaForkOptions jvmArgs(Iterable<?> arguments)
    
    Adds some arguments to use to launch the JVM for the process.
    Parameters:
    arguments - The arguments. Must not be null.
    Returns:
    this
  - JavaForkOptions jvmArgs(Object... arguments)
    
    Adds some arguments to use to launch the JVM for the process.
    Parameters:
    arguments - The arguments.
    Returns:
    this
  - void setBootstrapClasspath(FileCollection classpath)
    
    Sets 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.
  - void setDebug(boolean enabled)
    
    Enable or disable debugging for the process. When enabled, the process is started suspended and listening on port 5005.
    Parameters:
    enabled - true to enable debugging, false to disable.
  - void setDefaultCharacterEncoding(String defaultCharacterEncoding)
    
    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().
    Parameters:
    defaultCharacterEncoding - The default character encoding. Use null java.nio.charset.Charset#defaultCharset() to use this JVM's default charset.
  - void setEnableAssertions(boolean enabled)
    
    Enable or disable assertions for the process.
    Parameters:
    enabled - true to enable assertions, false to disable.
  - void setEnvironment(java.util.Map<String, ?> environmentVariables)
    
    Sets the environment variable to use for the process.
    Parameters:
    environmentVariables - The environment variables. Must not be null.
  - void setExecutable(Object executable)
    
    Sets the name of the exe to use.
    Parameters:
    executable - The exe. Must not be null.
  - void setJvmArgs(Iterable<?> arguments)
    
    Sets 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.
  - void setMaxHeapSize(String heapSize)
    
    Sets the maximum heap size for the process.
    Parameters:
    heapSize - The heap size. Use null for the default maximum heap size.
  - void setMinHeapSize(String heapSize)
    
    Sets the minimum heap size for the process.
    Parameters:
    heapSize - The minimum heap size. Use null for the default minimum heap size.
  - void setSystemProperties(java.util.Map<String, ?> props)
    
    Sets the system properties to use for the process.
    Parameters:
    props - The system properties. Must not be null.
  - void setWorkingDir(Object dir)
    
    Sets the working directory for the process. The supplied argument is evaluated as per # file ( Object ).
    Parameters:
    dir - The working directory. Must not be null.
  - JavaForkOptions systemProperties(java.util.Map<String, ?> props)
    
    Adds some system properties to use for the process.
    Parameters:
    props - The system properties. Must not be null.
    Returns:
    this
  - JavaForkOptions systemProperty(String name, Object value)
    
    Adds 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
  - void workingDir(Object dir)
    
    Sets the working directory for the process. The supplied argument is evaluated as per # file ( Object ).
    Parameters:
    dir - The working directory. Must not be null.

Summary:
Property
Method

| Detail:
Property
Method

Groovy Documentation

[Groovy] Class JavaForkOptions

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

FileCollection bootstrapClasspath

String defaultCharacterEncoding

java.util.Map<String, Object> environment

String executable

java.util.List<String> jvmArgs

String maxHeapSize

String minHeapSize

java.util.Map<String, Object> systemProperties

Object workingDir

Method Detail

JavaForkOptions bootstrapClasspath(Object... classpath)

JavaForkOptions copyTo(JavaForkOptions options)

ProcessForkOptions copyTo(ProcessForkOptions options)

void environment(java.util.Map<String, ?> environmentVariables)

void environment(String name, Object value)

void executable(Object executable)

FileCollection getBootstrapClasspath()

boolean getDebug()

String getDefaultCharacterEncoding()

boolean getEnableAssertions()

java.util.Map<String, Object> getEnvironment()

String getExecutable()

java.util.List<String> getJvmArgs()

String getMaxHeapSize()

String getMinHeapSize()

java.util.Map<String, Object> getSystemProperties()

Object getWorkingDir()

JavaForkOptions jvmArgs(Iterable<?> arguments)

JavaForkOptions jvmArgs(Object... arguments)

void setBootstrapClasspath(FileCollection classpath)

void setDebug(boolean enabled)

void setDefaultCharacterEncoding(String defaultCharacterEncoding)

void setEnableAssertions(boolean enabled)

void setEnvironment(java.util.Map<String, ?> environmentVariables)

void setExecutable(Object executable)

void setJvmArgs(Iterable<?> arguments)

void setMaxHeapSize(String heapSize)

void setMinHeapSize(String heapSize)

void setSystemProperties(java.util.Map<String, ?> props)

void setWorkingDir(Object dir)

JavaForkOptions systemProperties(java.util.Map<String, ?> props)

JavaForkOptions systemProperty(String name, Object value)

void workingDir(Object dir)