# GroovyCompileOptions

abstract class GroovyCompileOptions : Serializable(source)

Compilation options to be passed to the Groovy compiler.

## Constructors

GroovyCompileOptions
Link copied to clipboard
constructor()

## Properties

encoding
Link copied to clipboard
@get:Input
open var encoding: String
fileExtensions
Link copied to clipboard
@get:Input
open var fileExtensions: List<String>
optimizationOptions
Link copied to clipboard
@get:Nullable
@get:Optional
@get:Input
open var optimizationOptions: Map<String, Boolean>

## Functions

forkOptions
Link copied to clipboard
open fun forkOptions(action: Action<in GroovyForkOptions>)
Execute the given action against getForkOptions.
getConfigurationScript
Link copied to clipboard
@ReplacedBy(value = "configurationScriptFile")
@Nullable
open fun getConfigurationScript(): @Nullable File
Returns the path to the groovy configuration file.
getConfigurationScriptFile
Link copied to clipboard
@Incubating
@Optional
@PathSensitive(value = PathSensitivity.NONE)
@InputFile
abstract fun getConfigurationScriptFile(): RegularFileProperty
A Groovy script file that configures the compiler, allowing extensive control over how the code is compiled.
getDisabledGlobalASTTransformations
Link copied to clipboard
@Input
abstract fun getDisabledGlobalASTTransformations(): SetProperty<String>
Returns the set of global AST transformations which should not be loaded into the Groovy compiler.
getForkOptions
Link copied to clipboard
abstract fun getForkOptions(): GroovyForkOptions
Returns options for running the Groovy compiler in a separate process.
getStubDir
Link copied to clipboard
@ReplacedBy(value = "stubDirectory")
open fun getStubDir(): File
Returns the directory where Java stubs for Groovy classes will be stored during Java/Groovy joint compilation.
getStubDirectory
Link copied to clipboard
@Incubating
@Internal
abstract fun getStubDirectory(): DirectoryProperty
Returns the directory where Java stubs for Groovy classes will be stored during Java/Groovy joint compilation.
isFailOnError
Link copied to clipboard
@Input
open fun isFailOnError(): Boolean
Tells whether the compilation task should fail if compile errors occurred.
isFork
Link copied to clipboard
@Input
open fun isFork(): Boolean
Tells whether to run the Groovy compiler in a separate process.
isJavaAnnotationProcessing
Link copied to clipboard
@Input
open fun isJavaAnnotationProcessing(): Boolean
Whether the Groovy code should be subject to Java annotation processing.
isKeepStubs
Link copied to clipboard
@Input
open fun isKeepStubs(): Boolean
Tells whether Java stubs for Groovy classes generated during Java/Groovy joint compilation should be kept after compilation has completed.
isListFiles
Link copied to clipboard
@Console
open fun isListFiles(): Boolean
Tells whether to print which source files are to be compiled.
isParameters
Link copied to clipboard
@Input
open fun isParameters(): Boolean
Whether the Groovy compiler generate metadata for reflection on method parameter names on JDK 8 and above.
isVerbose
Link copied to clipboard
@Console
open fun isVerbose(): Boolean
Tells whether to turn on verbose output.
setConfigurationScript
Link copied to clipboard
open fun setConfigurationScript(@Nullable configurationFile: @Nullable File)
Sets the path to the groovy configuration file.
setFailOnError
Link copied to clipboard
open fun setFailOnError(failOnError: Boolean)
Sets whether the compilation task should fail if compile errors occurred.
setFork
Link copied to clipboard
open fun setFork(fork: Boolean)
Sets whether to run the Groovy compiler in a separate process.
setJavaAnnotationProcessing
Link copied to clipboard
open fun setJavaAnnotationProcessing(javaAnnotationProcessing: Boolean)
Sets whether Java annotation processors should process annotations on stubs.
setKeepStubs
Link copied to clipboard
open fun setKeepStubs(keepStubs: Boolean)
Sets whether Java stubs for Groovy classes generated during Java/Groovy joint compilation should be kept after compilation has completed.
setListFiles
Link copied to clipboard
open fun setListFiles(listFiles: Boolean)
Sets whether to print which source files are to be compiled.
setParameters
Link copied to clipboard
open fun setParameters(parameters: Boolean)
Sets whether metadata for reflection on method parameter names should be generated.
setStubDir
Link copied to clipboard
open fun setStubDir(stubDir: File)
Sets the directory where Java stubs for Groovy classes will be stored during Java/Groovy joint compilation.
setVerbose
Link copied to clipboard
open fun setVerbose(verbose: Boolean)
Sets whether to turn on verbose output.