Overview | Package | Class | Deprecated | Index | Help
| Groovy Documentation
| FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.gradle.api.tasks.compile
[Java] Class ForkOptions

    java.lang.Object
      org.gradle.api.tasks.compile.AbstractOptions
          org.gradle.api.tasks.compile.ForkOptions

    public class ForkOptions
    extends AbstractOptions

Fork options for Java compilation. Only take effect if `CompileOptions.fork` is `true`.

Authors:
  Hans Dockter

Method Summary
`protected List` | `excludedFieldsFromOptionMap()` Internal method.
`protected Map` | `fieldName2AntMap()` Internal method.
`String` | `getExecutable()` Returns the compiler executable to be used.
`List` | `getJvmArgs()` Returns any additional JVM arguments for the compiler process.
`String` | `getMemoryInitialSize()` Returns the initial heap size for the compiler process.
`String` | `getMemoryMaximumSize()` Returns the maximum heap size for the compiler process.
`String` | `getTempDir()` Returns the directory used for temporary files that may be created to pass command line arguments to the compiler process.
`void` | `setExecutable(String executable)` Sets the compiler executable to be used.
`void` | `setJvmArgs(List jvmArgs)` Sets any additional JVM arguments for the compiler process.
`void` | `setMemoryInitialSize(String memoryInitialSize)` Sets the initial heap size for the compiler process.
`void` | `setMemoryMaximumSize(String memoryMaximumSize)` Sets the maximum heap size for the compiler process.
`void` | `setTempDir(String tempDir)` Sets the directory used for temporary files that may be created to pass command line arguments to the compiler process.

Methods inherited from class AbstractOptions
define, excludedFieldsFromOptionMap, fieldName2AntMap, fieldValue2AntMap, optionMap

Method Detail

### excludedFieldsFromOptionMap

    protected List excludedFieldsFromOptionMap()

  Internal method.

### fieldName2AntMap

    protected Map fieldName2AntMap()

  Internal method.

### getExecutable

    @Input
    @Optional
    public String getExecutable()

  Returns the compiler executable to be used. If set, a new compiler process will be forked for every compile task. Defaults to `null`.

### getJvmArgs

    @Input
    @Optional
    public List getJvmArgs()

  Returns any additional JVM arguments for the compiler process. Defaults to the empty list.

### getMemoryInitialSize

    public String getMemoryInitialSize()

  Returns the initial heap size for the compiler process. Defaults to `null`, in which case the JVM's default will be used.

### getMemoryMaximumSize

    public String getMemoryMaximumSize()

  Returns the maximum heap size for the compiler process. Defaults to `null`, in which case the JVM's default will be used.

### getTempDir

    public String getTempDir()

  Returns the directory used for temporary files that may be created to pass command line arguments to the compiler process. Defaults to `null`, in which case the directory will be chosen automatically.

### setExecutable

    public void setExecutable(String executable)

  Sets the compiler executable to be used. If set, a new compiler process will be forked for every compile task. Defaults to `null`.

### setJvmArgs

    public void setJvmArgs(List jvmArgs)

  Sets any additional JVM arguments for the compiler process. Defaults to the empty list.

### setMemoryInitialSize

    public void setMemoryInitialSize(String memoryInitialSize)

  Sets the initial heap size for the compiler process. Defaults to `null`, in which case the JVM's default will be used.

### setMemoryMaximumSize

    public void setMemoryMaximumSize(String memoryMaximumSize)

  Sets the maximum heap size for the compiler process. Defaults to `null`, in which case the JVM's default will be used.

### setTempDir

    public void setTempDir(String tempDir)

  Sets the directory used for temporary files that may be created to pass command line arguments to the compiler process. Defaults to `null`, in which case the directory will be chosen automatically.

Gradle API 1.1-rc-1