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 GroovyCompileOptions

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

    public class GroovyCompileOptions
    extends AbstractOptions

Compilation options to be passed to the Groovy compiler.

Method Summary
`protected boolean` | `excludeFromAntProperties(String fieldName)`
`GroovyCompileOptions` | `fork(Map forkArgs)` Convenience method to set GroovyForkOptions with named parameter syntax.
`String` | `getEncoding()` Tells the source encoding.
`List` | `getFileExtensions()` Returns the list of acceptable source file extensions.
`GroovyForkOptions` | `getForkOptions()` Returns options for running the Groovy compiler in a separate process.
`Map` | `getOptimizationOptions()` Returns optimization options for the Groovy compiler.
`File` | `getStubDir()` Returns the directory where Java stubs for Groovy classes will be stored during Java/Groovy joint compilation.
`boolean` | `isFailOnError()` Tells whether the compilation task should fail if compile errors occurred.
`boolean` | `isFork()` Tells whether to run the Groovy compiler in a separate process.
`boolean` | `isIncludeJavaRuntime()` Tells whether the Java runtime should be put on the compile class path.
`boolean` | `isKeepStubs()` Tells whether Java stubs for Groovy classes generated during Java/Groovy joint compilation should be kept after compilation has completed.
`boolean` | `isListFiles()` Tells whether to print which source files are to be compiled.
`boolean` | `isStacktrace()` Tells whether to print a stack trace when the compiler hits a problem (like a compile error).
`boolean` | `isUseAnt()` Tells whether the groovyc Ant task should be used over Gradle's own Groovy compiler integration.
`boolean` | `isVerbose()` Tells whether to turn on verbose output.
`Map` | `optionMap()` Internal method.
`void` | `setEncoding(String encoding)` Sets the source encoding.
`void` | `setFailOnError(boolean failOnError)` Sets whether the compilation task should fail if compile errors occurred.
`void` | `setFileExtensions(List fileExtensions)` Sets the list of acceptable source file extensions.
`void` | `setFork(boolean fork)` Sets whether to run the Groovy compiler in a separate process.
`void` | `setForkOptions(GroovyForkOptions forkOptions)` Sets options for running the Groovy compiler in a separate process.
`void` | `setIncludeJavaRuntime(boolean includeJavaRuntime)` Sets whether the Java runtime should be put on the compile class path.
`void` | `setKeepStubs(boolean keepStubs)` Sets whether Java stubs for Groovy classes generated during Java/Groovy joint compilation should be kept after compilation has completed.
`void` | `setListFiles(boolean listFiles)` Sets whether to print which source files are to be compiled.
`void` | `setOptimizationOptions(Map optimizationOptions)` Sets optimization options for the Groovy compiler.
`void` | `setStacktrace(boolean stacktrace)` Sets whether to print a stack trace when the compiler hits a problem (like a compile error).
`void` | `setStubDir(File stubDir)` Sets the directory where Java stubs for Groovy classes will be stored during Java/Groovy joint compilation.
`void` | `setUseAnt(boolean useAnt)` Sets whether the groovyc Ant task should be used over Gradle's own Groovy compiler integration.
`void` | `setVerbose(boolean verbose)` Sets whether to turn on verbose output.

Methods inherited from class AbstractOptions
define, excludeFromAntProperties, getAntPropertyName, getAntPropertyValue, optionMap

Method Detail

### excludeFromAntProperties

    @Override
    protected boolean excludeFromAntProperties(String fieldName)

### fork

    public GroovyCompileOptions fork(Map forkArgs)

  Convenience method to set GroovyForkOptions with named parameter syntax. Calling this method will set `fork` to `true`.

### getEncoding

    @Input
    public String getEncoding()

  Tells the source encoding. Defaults to `UTF-8`.

### getFileExtensions

    @Input
    @Incubating
    public List getFileExtensions()

  Returns the list of acceptable source file extensions. Only takes effect when compiling against Groovy 1.7 or higher. Defaults to `ImmutableList.of("java", "groovy")`.

### getForkOptions

    public GroovyForkOptions getForkOptions()

  Returns options for running the Groovy compiler in a separate process. These options only take effect if `fork` is set to `true`.

### getOptimizationOptions

    public Map getOptimizationOptions()

  Returns optimization options for the Groovy compiler. Allowed values for an option are `true` and `false`. Only takes effect when compiling against Groovy 1.8 or higher.

  Known options are:

  indy
    Use the invokedynamic bytecode instruction. Requires JDK7 or higher and Groovy 2.0 or higher. Disabled by default.
  int
    Optimize operations on primitive types (e.g. integers). Enabled by default.
  all
    Enable or disable all optimizations. Note that some optimizations might be mutually exclusive.

### getStubDir

    public File getStubDir()

  Returns the directory where Java stubs for Groovy classes will be stored during Java/Groovy joint compilation. Defaults to `null`, in which case a temporary directory will be used.

### isFailOnError

    public boolean isFailOnError()

  Tells whether the compilation task should fail if compile errors occurred. Defaults to `true`.

### isFork

    public boolean isFork()

  Tells whether to run the Groovy compiler in a separate process. Defaults to `true`.

### isIncludeJavaRuntime

    @Input
    @Deprecated
    public boolean isIncludeJavaRuntime()

  Tells whether the Java runtime should be put on the compile class path. Only takes effect if `useAnt` is `true`. Defaults to `false`.
  deprecated:
    No replacement

### isKeepStubs

    public boolean isKeepStubs()

  Tells whether Java stubs for Groovy classes generated during Java/Groovy joint compilation should be kept after compilation has completed. Useful for joint compilation debugging purposes. Defaults to `false`.

### isListFiles

    public boolean isListFiles()

  Tells whether to print which source files are to be compiled. Defaults to `false`.

### isStacktrace

    @Deprecated
    public boolean isStacktrace()

  Tells whether to print a stack trace when the compiler hits a problem (like a compile error). Defaults to `false`. Only used when isUseAnt() is `true`.
  deprecated:
    No replacement

### isUseAnt

    @Input
    @Deprecated
    public boolean isUseAnt()

  Tells whether the groovyc Ant task should be used over Gradle's own Groovy compiler integration. Defaults to `false`.
  deprecated:
    No replacement

### isVerbose

    public boolean isVerbose()

  Tells whether to turn on verbose output. Defaults to `false`.

### optionMap

    public Map optionMap()

  Internal method.

### setEncoding

    public void setEncoding(String encoding)

  Sets the source encoding. Defaults to `UTF-8`.

### setFailOnError

    public void setFailOnError(boolean failOnError)

  Sets whether the compilation task should fail if compile errors occurred. Defaults to `true`.

### setFileExtensions

    @Incubating
    public void setFileExtensions(List fileExtensions)

  Sets the list of acceptable source file extensions. Only takes effect when compiling against Groovy 1.7 or higher. Defaults to `ImmutableList.of("java", "groovy")`.

### setFork

    public void setFork(boolean fork)

  Sets whether to run the Groovy compiler in a separate process. Defaults to `true`.

### setForkOptions

    public void setForkOptions(GroovyForkOptions forkOptions)

  Sets options for running the Groovy compiler in a separate process. These options only take effect if `fork` is set to `true`.

### setIncludeJavaRuntime

    @Deprecated
    public void setIncludeJavaRuntime(boolean includeJavaRuntime)

  Sets whether the Java runtime should be put on the compile class path. Only takes effect if `useAnt` is `true`. Defaults to `false`.
  deprecated:
    No replacement

### setKeepStubs

    public void setKeepStubs(boolean keepStubs)

  Sets whether Java stubs for Groovy classes generated during Java/Groovy joint compilation should be kept after compilation has completed. Useful for joint compilation debugging purposes. Defaults to `false`.

### setListFiles

    public void setListFiles(boolean listFiles)

  Sets whether to print which source files are to be compiled. Defaults to `false`.

### setOptimizationOptions

    public void setOptimizationOptions(Map optimizationOptions)

  Sets optimization options for the Groovy compiler. Allowed values for an option are `true` and `false`. Only takes effect when compiling against Groovy 1.8 or higher.

### setStacktrace

    @Deprecated
    public void setStacktrace(boolean stacktrace)

  Sets whether to print a stack trace when the compiler hits a problem (like a compile error). Defaults to `false`. Only used when isUseAnt() is `true`.
  deprecated:
    No replacement

### setStubDir

    public void setStubDir(File stubDir)

  Sets the directory where Java stubs for Groovy classes will be stored during Java/Groovy joint compilation. Defaults to `null`, in which case a temporary directory will be used.

### setUseAnt

    @Deprecated
    public void setUseAnt(boolean useAnt)

  Sets whether the groovyc Ant task should be used over Gradle's own Groovy compiler integration. Defaults to `false`.
  deprecated:
    No replacement

### setVerbose

    public void setVerbose(boolean verbose)

  Sets whether to turn on verbose output. Defaults to `false`.

Gradle API 1.10