gradle/org.gradle.api.tasks.compile/CompileOptions

CompileOptions

abstract class CompileOptions : Serializable(source)

Main options for Java compilation.

Constructors

Link copied to clipboard
@Inject
constructor(objectFactory: ObjectFactory)

Functions

Link copied to clipboard
open fun debugOptions(action: Action<in DebugOptions>)
Execute the given action against getDebugOptions.
Link copied to clipboard
open fun forkOptions(action: Action<in ForkOptions>)
Execute the given action against getForkOptions.
Link copied to clipboard
@Internal
open fun getAllCompilerArgs(): Provider<List<String>>
Returns all compiler arguments, added to the getCompilerArgs or the getCompilerArgumentProviders property.
Link copied to clipboard
@Optional
@Classpath
abstract fun getAnnotationProcessorPath(): ConfigurableFileCollection
Returns the classpath to use to load annotation processors.
Link copied to clipboard
@Optional
@CompileClasspath
abstract fun getBootstrapClasspath(): ConfigurableFileCollection
Returns the bootstrap classpath to be used for the compiler process.
Link copied to clipboard
@Input
abstract fun getCompilerArgs(): ListProperty<String>
Returns any additional arguments to be passed to the compiler.
Link copied to clipboard
abstract fun getCompilerArgumentProviders(): ListProperty<CommandLineArgumentProvider>
Compiler argument providers.
Link copied to clipboard
@Input
abstract fun getDebug(): Property<Boolean>
Tells whether to include debugging information in the generated class files.
Link copied to clipboard
abstract fun getDebugOptions(): DebugOptions
Returns options for generating debugging information.
Link copied to clipboard
@Console
abstract fun getDeprecation(): Property<Boolean>
Tells whether to log details of usage of deprecated members or classes.
Link copied to clipboard
@Optional
@Input
abstract fun getEncoding(): Property<String>
Returns the character encoding to be used when reading source files.
Link copied to clipboard
@Optional
@Input
abstract fun getExtensionDirs(): Property<String>
Returns the extension dirs to be used for the compiler process.
Link copied to clipboard
@Input
abstract fun getFailOnError(): Property<Boolean>
Sets whether to fail the build when compilation fails.
Link copied to clipboard
@Input
abstract fun getFork(): Property<Boolean>
Tells whether to run the compiler in its own process.
Link copied to clipboard
abstract fun getForkOptions(): ForkOptions
Returns options for running the compiler in a child process.
Link copied to clipboard
@Optional
@OutputDirectory
abstract fun getGeneratedSourceOutputDirectory(): DirectoryProperty
Returns the directory to place source files generated by annotation processors.
Link copied to clipboard
@Optional
@OutputDirectory
abstract fun getHeaderOutputDirectory(): DirectoryProperty
If this option is set to a non-null directory, it will be passed to the Java compiler's `-h` option, prompting it to generate native headers to that directory.
Link copied to clipboard
@Internal
abstract fun getIncremental(): Property<Boolean>
informs whether to use incremental compilation feature.
Link copied to clipboard
@Input
@Optional
abstract fun getIncrementalAfterFailure(): Property<Boolean>
Used to enable or disable incremental compilation after a failure.
Link copied to clipboard
@ReplacedBy(value = "debug")
open fun getIsDebug(): Property<Boolean>
Sets whether to include debugging information in the generated class files.
Link copied to clipboard
@ReplacedBy(value = "deprecation")
open fun getIsDeprecation(): Property<Boolean>
Sets whether to log details of usage of deprecated members or classes.
Link copied to clipboard
@ReplacedBy(value = "failOnError")
open fun getIsFailOnError(): Property<Boolean>
Link copied to clipboard
@ReplacedBy(value = "fork")
open fun getIsFork(): Property<Boolean>
Sets whether to run the compiler in its own process.
Link copied to clipboard
@ReplacedBy(value = "incremental")
open fun getIsIncremental(): Property<Boolean>
Link copied to clipboard
@ReplacedBy(value = "listFiles")
open fun getIsListFiles(): Property<Boolean>
Link copied to clipboard
@ReplacedBy(value = "verbose")
open fun getIsVerbose(): Property<Boolean>
Link copied to clipboard
@ReplacedBy(value = "warnings")
open fun getIsWarnings(): Property<Boolean>
Sets whether to log warning messages.
Link copied to clipboard
@Optional
@Input
abstract fun getJavaModuleMainClass(): Property<String>
Set the main class of the Java module, if the module is supposed to be executable.
Link copied to clipboard
@Optional
@Input
abstract fun getJavaModuleVersion(): Property<String>
Set the version of the Java module.
Link copied to clipboard
@Console
abstract fun getListFiles(): Property<Boolean>
Tells whether to log the files to be compiled.
Link copied to clipboard
@Input
@Optional
abstract fun getRelease(): Property<Integer>
Configures the Java language version for this compile task (--release compiler flag).
Link copied to clipboard
@Optional
@IgnoreEmptyDirectories
@PathSensitive(value = PathSensitivity.RELATIVE)
@InputFiles
abstract fun getSourcepath(): ConfigurableFileCollection
The source path to use for the compilation.
Link copied to clipboard
@Console
abstract fun getVerbose(): Property<Boolean>
Tells whether to produce verbose output.
Link copied to clipboard
@Console
abstract fun getWarnings(): Property<Boolean>
Tells whether to log warning messages.
Link copied to clipboard
open fun setAnnotationProcessorPath(@Nullable annotationProcessorPath: @Nullable FileCollection)
Set the classpath to use to load annotation processors.
Link copied to clipboard
open fun setBootstrapClasspath(@Nullable bootstrapClasspath: @Nullable FileCollection)
Sets the bootstrap classpath to be used for the compiler process.
Link copied to clipboard
open fun setCompilerArgs(compilerArgs: List<String>)
Sets any additional arguments to be passed to the compiler.
Link copied to clipboard
open fun setDebug(debug: Boolean)
Sets whether to include debugging information in the generated class files.
Link copied to clipboard
open fun setDeprecation(deprecation: Boolean)
Sets whether to log details of usage of deprecated members or classes.
Link copied to clipboard
open fun setEncoding(@Nullable encoding: @Nullable String)
Sets the character encoding to be used when reading source files.
Link copied to clipboard
open fun setExtensionDirs(@Nullable extensionDirs: @Nullable String)
Sets the extension dirs to be used for the compiler process.
Link copied to clipboard
open fun setFailOnError(failOnError: Boolean)
Sets whether to fail the build when compilation fails.
Link copied to clipboard
open fun setFork(fork: Boolean)
Sets whether to run the compiler in its own process.
Link copied to clipboard
open fun setIncremental(incremental: Boolean): CompileOptions
Configure the java compilation to be incremental (e.g.
Link copied to clipboard
open fun setListFiles(listFiles: Boolean)
Sets whether to log the files to be compiled.
Link copied to clipboard
open fun setSourcepath(@Nullable sourcepath: @Nullable FileCollection)
Sets the source path to use for the compilation.
Link copied to clipboard
open fun setVerbose(verbose: Boolean)
Sets whether to produce verbose output.
Link copied to clipboard
open fun setWarnings(warnings: Boolean)
Sets whether to log warning messages.
Generated by Dokka
Gradle Kotlin DSL Reference