gradle/org.gradle.api.tasks.compile/GroovyCompileOptions

GroovyCompileOptions

abstract class GroovyCompileOptions : Serializable(source)

Compilation options to be passed to the Groovy compiler.

Constructors

constructor()

Functions

forkOptions

open fun forkOptions(action: Action<in GroovyForkOptions>)

Execute the given action against getForkOptions.

getConfigurationScript

@ReplacedBy(value = "configurationScriptFile")

@Nullable

open fun getConfigurationScript(): @Nullable File

Returns the path to the groovy configuration file.

getConfigurationScriptFile

@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

@Input

abstract fun getDisabledGlobalASTTransformations(): SetProperty<String>

Returns the set of global AST transformations which should not be loaded into the Groovy compiler.

getEncoding

@Input

abstract fun getEncoding(): Property<String>

Tells the source encoding.

getFailOnError

@Input

abstract fun getFailOnError(): Property<Boolean>

Tells whether the compilation task should fail if compile errors occurred.

getFileExtensions

@Input

abstract fun getFileExtensions(): ListProperty<String>

Returns the list of acceptable source file extensions.

getFork

@Input

abstract fun getFork(): Property<Boolean>

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

getForkOptions

abstract fun getForkOptions(): GroovyForkOptions

Returns options for running the Groovy compiler in a separate process.

getIsFailOnError

@Internal

open fun getIsFailOnError(): Property<Boolean>

getIsFork

@Internal

open fun getIsFork(): Property<Boolean>

getIsJavaAnnotationProcessing

@Internal

open fun getIsJavaAnnotationProcessing(): Property<Boolean>

getIsKeepStubs

@Internal

open fun getIsKeepStubs(): Property<Boolean>

getIsListFiles

@Internal

open fun getIsListFiles(): Property<Boolean>

getIsParameters

@Internal

open fun getIsParameters(): Property<Boolean>

getIsVerbose

@Internal

open fun getIsVerbose(): Property<Boolean>

getJavaAnnotationProcessing

@Input

abstract fun getJavaAnnotationProcessing(): Property<Boolean>

Whether the Groovy code should be subject to Java annotation processing.

getKeepStubs

@Input

abstract fun getKeepStubs(): Property<Boolean>

Tells whether Java stubs for Groovy classes generated during Java/Groovy joint compilation should be kept after compilation has completed.

getListFiles

@Console

abstract fun getListFiles(): Property<Boolean>

Tells whether to print which source files are to be compiled.

getOptimizationOptions

@Input

@Optional

abstract fun getOptimizationOptions(): MapProperty<String, Boolean>

Returns optimization options for the Groovy compiler.

getParameters

@Input

abstract fun getParameters(): Property<Boolean>

Whether the Groovy compiler generate metadata for reflection on method parameter names on JDK 8 and above.

getStubDir

@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

@Incubating

@Internal

abstract fun getStubDirectory(): DirectoryProperty

Returns the directory where Java stubs for Groovy classes will be stored during Java/Groovy joint compilation.

getVerbose

@Console

abstract fun getVerbose(): Property<Boolean>

Tells whether to turn on verbose output.

setConfigurationScript

open fun setConfigurationScript(@Nullable configurationFile: @Nullable File)

Sets the path to the groovy configuration file.

setEncoding

open fun setEncoding(encoding: String)

Sets the source encoding.

setFailOnError

open fun setFailOnError(failOnError: Boolean)

Sets whether the compilation task should fail if compile errors occurred.

setFileExtensions

open fun setFileExtensions(fileExtensions: List<String>)

Sets the list of acceptable source file extensions.

setFork

open fun setFork(fork: Boolean)

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

setJavaAnnotationProcessing

open fun setJavaAnnotationProcessing(javaAnnotationProcessing: Boolean)

Sets whether Java annotation processors should process annotations on stubs.

setKeepStubs

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

open fun setListFiles(listFiles: Boolean)

Sets whether to print which source files are to be compiled.

setOptimizationOptions

open fun setOptimizationOptions(@Nullable optimizationOptions: @Nullable Map<String, Boolean>)

Sets optimization options for the Groovy compiler.

setParameters

open fun setParameters(parameters: Boolean)

Sets whether metadata for reflection on method parameter names should be generated.

setStubDir

open fun setStubDir(stubDir: File)

Sets the directory where Java stubs for Groovy classes will be stored during Java/Groovy joint compilation.

setVerbose

open fun setVerbose(verbose: Boolean)

Sets whether to turn on verbose output.