GroovyCompileOptions (Gradle API 1.1)

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

All Implemented Interfaces:

Serializable
```
public class GroovyCompileOptions
extends AbstractOptions
```
Compilation options to be passed to the Groovy compiler.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

GroovyCompileOptions()

Constructors
Constructor and Description
`GroovyCompileOptions()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected List<String>`	`excludedFieldsFromOptionMap()` Internal method.
`protected Map<String,String>`	`fieldName2AntMap()` Internal method.
`GroovyCompileOptions`	`fork(Map forkArgs)` Convenience method to set `ForkOptions` with named parameter syntax.
`String`	`getEncoding()` Tells the source encoding.
`List<String>`	`getFileExtensions()` Returns the list of acceptable source file extensions.
`GroovyForkOptions`	`getForkOptions()` Returns options for running the Groovy compiler in a separate process.
`Map<String,Boolean>`	`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<String,Object>`	`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<String> 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<String,Boolean> 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 org.gradle.api.tasks.compile.AbstractOptions
define, fieldValue2AntMap

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GroovyCompileOptions
```
public GroovyCompileOptions()
```
- Method Detail
  - isFailOnError
```
public boolean isFailOnError()
```
    Tells whether the compilation task should fail if compile errors occurred. Defaults to true.
  - setFailOnError
```
public void setFailOnError(boolean failOnError)
```
    Sets whether the compilation task should fail if compile errors occurred. Defaults to true.
  - isVerbose
```
public boolean isVerbose()
```
    Tells whether to turn on verbose output. Defaults to false.
  - setVerbose
```
public void setVerbose(boolean verbose)
```
    Sets whether to turn on verbose output. Defaults to false.
  - isListFiles
```
public boolean isListFiles()
```
    Tells whether to print which source files are to be compiled. Defaults to false.
  - setListFiles
```
public void setListFiles(boolean listFiles)
```
    Sets whether to print which source files are to be compiled. Defaults to false.
  - getEncoding
```
@Input
public String getEncoding()
```
    Tells the source encoding. Defaults to UTF-8.
  - setEncoding
```
public void setEncoding(String encoding)
```
    Sets the source encoding. Defaults to UTF-8.
  - isFork
```
public boolean isFork()
```
    Tells whether to run the Groovy compiler in a separate process. Defaults to true.
  - setFork
```
public void setFork(boolean fork)
```
    Sets whether to run the Groovy compiler in a separate process. Defaults to true.
  - 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.
  - 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.
  - getOptimizationOptions
```
public Map<String,Boolean> 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.
  - setOptimizationOptions
```
public void setOptimizationOptions(Map<String,Boolean> 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.
  - isStacktrace
```
public boolean isStacktrace()
```
    Tells whether to print a stack trace when the compiler hits a problem (like a compile error). Defaults to false.
  - setStacktrace
```
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.
  - isUseAnt
```
@Input
public boolean isUseAnt()
```
    Tells whether the groovyc Ant task should be used over Gradle's own Groovy compiler integration. Defaults to false.
  - setUseAnt
```
public void setUseAnt(boolean useAnt)
```
    Sets whether the groovyc Ant task should be used over Gradle's own Groovy compiler integration. Defaults to false.
  - isIncludeJavaRuntime
```
@Input
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.
  - setIncludeJavaRuntime
```
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.
  - 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.
  - 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.
  - getFileExtensions
```
@Input
@Experimental
public List<String> 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").
  - setFileExtensions
```
@Experimental
public void setFileExtensions(List<String> 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").
  - 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.
  - 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.
  - fork
```
public GroovyCompileOptions fork(Map forkArgs)
```
    Convenience method to set ForkOptions with named parameter syntax. Calling this method will set fork to true.
  - excludedFieldsFromOptionMap
```
protected List<String> excludedFieldsFromOptionMap()
```
    Internal method.
    
    Overrides:
    
    excludedFieldsFromOptionMap in class AbstractOptions
  - fieldName2AntMap
```
protected Map<String,String> fieldName2AntMap()
```
    Internal method.
    
    Overrides:
    
    fieldName2AntMap in class AbstractOptions
  - optionMap
```
public Map<String,Object> optionMap()
```
    Internal method.
    
    Overrides:
    
    optionMap in class AbstractOptions

Class GroovyCompileOptions

Constructor Summary

Method Summary

Methods inherited from class org.gradle.api.tasks.compile.AbstractOptions

Methods inherited from class java.lang.Object

Constructor Detail

GroovyCompileOptions

Method Detail

isFailOnError

setFailOnError

isVerbose

setVerbose

isListFiles

setListFiles

getEncoding

setEncoding

isFork

setFork

getForkOptions

setForkOptions

getOptimizationOptions

setOptimizationOptions

isStacktrace

setStacktrace

isUseAnt

setUseAnt

isIncludeJavaRuntime

setIncludeJavaRuntime

getStubDir

setStubDir

getFileExtensions

setFileExtensions

isKeepStubs

setKeepStubs

fork

excludedFieldsFromOptionMap

fieldName2AntMap

optionMap