gradle
8.3

# GroovyCompileOptions

abstract class GroovyCompileOptions : AbstractOptions

Compilation options to be passed to the Groovy compiler.

## Constructors

GroovyCompileOptions
Link copied to clipboard
constructor()

## Functions

define
Link copied to clipboard
open fun define(args: Map<String, Any>)
define
Link copied to clipboard
inline fun AbstractOptions.define(vararg args: Pair<String, Any?>)

Kotlin extension function for org.gradle.api.tasks.compile.AbstractOptions.define.

fork
Link copied to clipboard
open fun fork(forkArgs: Map<String, Any>): GroovyCompileOptions
Convenience method to set GroovyForkOptions with named parameter syntax.
fork
Link copied to clipboard
inline fun GroovyCompileOptions.fork(vararg forkArgs: Pair<String, Any?>): GroovyCompileOptions

Kotlin extension function for org.gradle.api.tasks.compile.GroovyCompileOptions.fork.

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.
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.
setVerbose
Link copied to clipboard
open fun setVerbose(verbose: Boolean)
Sets whether to turn on verbose output.

## Properties

configurationScript
Link copied to clipboard
@get:Nullable
@get:Optional
@get:PathSensitive(value = PathSensitivity.NONE)
@get:InputFile
open var configurationScript: File
disabledGlobalASTTransformations
Link copied to clipboard
@get:Input
val disabledGlobalASTTransformations: SetProperty<String>
encoding
Link copied to clipboard
@get:Input
open var encoding: String
fileExtensions
Link copied to clipboard
@get:Input
open var fileExtensions: List<String>
forkOptions
Link copied to clipboard
open var forkOptions: GroovyForkOptions
optimizationOptions
Link copied to clipboard
@get:Nullable
@get:Optional
@get:Input
open var optimizationOptions: Map<String, Boolean>
stubDir
Link copied to clipboard
@get:Internal
open var stubDir: File