Class CompileOptions
- All Implemented Interfaces:
Serializable
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.This method will be removed in Gradle 9.0voiddebugOptions(Action<? super DebugOptions> action) Execute the given action againstgetDebugOptions().Deprecated.This method will be removed in Gradle 9.0voidforkOptions(Action<? super ForkOptions> action) Execute the given action againstgetForkOptions().Returns all compiler arguments, added to thegetCompilerArgs()or thegetCompilerArgumentProviders()property.Deprecated.UsegetGeneratedSourceOutputDirectory()instead.Returns the classpath to use to load annotation processors.Returns the bootstrap classpath to be used for the compiler process.Returns any additional arguments to be passed to the compiler.Compiler argument providers.Returns options for generating debugging information.Returns the character encoding to be used when reading source files.Returns the extension dirs to be used for the compiler process.Returns options for running the compiler in a child process.Returns the directory to place source files generated by annotation processors.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.Used to enable or disable incremental compilation after a failure.Set the main class of the Java module, if the module is supposed to be executable.Set the version of the Java module.Configures the Java language version for this compile task (--releasecompiler flag).The source path to use for the compilation.booleanisDebug()Tells whether to include debugging information in the generated class files.booleanTells whether to log details of usage of deprecated members or classes.booleanTells whether to fail the build when compilation fails.booleanisFork()Tells whether to run the compiler in its own process.booleaninforms whether to use incremental compilation feature.booleanTells whether to log the files to be compiled.booleanTells whether to produce verbose output.booleanTells whether to log warning messages.voidDeprecated.UsegetGeneratedSourceOutputDirectory().set() instead.voidDeprecated.UsegetGeneratedSourceOutputDirectory().set() instead.voidsetAnnotationProcessorPath(FileCollection annotationProcessorPath) Set the classpath to use to load annotation processors.voidsetBootstrapClasspath(FileCollection bootstrapClasspath) Sets the bootstrap classpath to be used for the compiler process.voidsetCompilerArgs(List<String> compilerArgs) Sets any additional arguments to be passed to the compiler.voidsetDebug(boolean debug) Sets whether to include debugging information in the generated class files.voidsetDebugOptions(DebugOptions debugOptions) Deprecated.Setting a new instance of this property is unnecessary.voidsetDeprecation(boolean deprecation) Sets whether to log details of usage of deprecated members or classes.voidsetEncoding(String encoding) Sets the character encoding to be used when reading source files.voidsetExtensionDirs(String extensionDirs) Sets the extension dirs to be used for the compiler process.voidsetFailOnError(boolean failOnError) Sets whether to fail the build when compilation fails.voidsetFork(boolean fork) Sets whether to run the compiler in its own process.voidsetForkOptions(ForkOptions forkOptions) Deprecated.Setting a new instance of this property is unnecessary.setIncremental(boolean incremental) Configure the java compilation to be incremental (e.g.voidsetListFiles(boolean listFiles) Sets whether to log the files to be compiled.voidsetSourcepath(FileCollection sourcepath) Sets the source path to use for the compilation.voidsetVerbose(boolean verbose) Sets whether to produce verbose output.voidsetWarnings(boolean warnings) Sets whether to log warning messages.Methods inherited from class org.gradle.api.tasks.compile.AbstractOptions
define
-
Constructor Details
-
CompileOptions
-
-
Method Details
-
isFailOnError
Tells whether to fail the build when compilation fails. Defaults totrue. -
setFailOnError
public void setFailOnError(boolean failOnError) Sets whether to fail the build when compilation fails. Defaults totrue. -
isVerbose
Tells whether to produce verbose output. Defaults tofalse. -
setVerbose
public void setVerbose(boolean verbose) Sets whether to produce verbose output. Defaults tofalse. -
isListFiles
Tells whether to log the files to be compiled. Defaults tofalse. -
setListFiles
public void setListFiles(boolean listFiles) Sets whether to log the files to be compiled. Defaults tofalse. -
isDeprecation
Tells whether to log details of usage of deprecated members or classes. Defaults tofalse. -
setDeprecation
public void setDeprecation(boolean deprecation) Sets whether to log details of usage of deprecated members or classes. Defaults tofalse. -
isWarnings
Tells whether to log warning messages. The default istrue. -
setWarnings
public void setWarnings(boolean warnings) Sets whether to log warning messages. The default istrue. -
getEncoding
Returns the character encoding to be used when reading source files. Defaults tonull, in which case the platform default encoding will be used. -
setEncoding
Sets the character encoding to be used when reading source files. Defaults tonull, in which case the platform default encoding will be used. -
isDebug
Tells whether to include debugging information in the generated class files. Defaults totrue. SeeDebugOptions.getDebugLevel()for which debugging information will be generated. -
setDebug
public void setDebug(boolean debug) Sets whether to include debugging information in the generated class files. Defaults totrue. SeeDebugOptions.getDebugLevel()for which debugging information will be generated. -
getDebugOptions
Returns options for generating debugging information. -
setDebugOptions
Deprecated.Setting a new instance of this property is unnecessary. This method will be removed in Gradle 9.0. UsedebugOptions(Action)instead.Sets options for generating debugging information. -
debugOptions
Execute the given action againstgetDebugOptions().- Since:
- 8.11
-
isFork
Tells whether to run the compiler in its own process. Note that this does not necessarily mean that a new process will be created for each compile task. Defaults tofalse. -
setFork
public void setFork(boolean fork) Sets whether to run the compiler in its own process. Note that this does not necessarily mean that a new process will be created for each compile task. Defaults tofalse. -
getForkOptions
Returns options for running the compiler in a child process. -
setForkOptions
Deprecated.Setting a new instance of this property is unnecessary. This method will be removed in Gradle 9.0. UseforkOptions(Action)instead.Sets options for running the compiler in a child process. -
forkOptions
Execute the given action againstgetForkOptions().- Since:
- 8.11
-
getBootstrapClasspath
Returns the bootstrap classpath to be used for the compiler process. Defaults tonull.- Since:
- 4.3
-
setBootstrapClasspath
Sets the bootstrap classpath to be used for the compiler process. Defaults tonull.- Since:
- 4.3
-
getExtensionDirs
Returns the extension dirs to be used for the compiler process. Defaults tonull. -
setExtensionDirs
Sets the extension dirs to be used for the compiler process. Defaults tonull. -
getCompilerArgs
Returns any additional arguments to be passed to the compiler. Defaults to the empty list. Compiler arguments not supported by the DSL can be added here. For example, it is possible to pass the--enable-previewoption that was added in newer Java versions:
Note that ifcompilerArgs.add("--enable-preview")--releaseis added then-targetand-sourceare ignored. -
getAllCompilerArgs
Returns all compiler arguments, added to thegetCompilerArgs()or thegetCompilerArgumentProviders()property.- Since:
- 4.5
-
getCompilerArgumentProviders
Compiler argument providers.- Since:
- 4.5
-
setCompilerArgs
Sets any additional arguments to be passed to the compiler. Defaults to the empty list. -
fork
Deprecated.This method will be removed in Gradle 9.0Convenience method to setForkOptionswith named parameter syntax. Calling this method will setforktotrue. -
debug
Deprecated.This method will be removed in Gradle 9.0Convenience method to setDebugOptionswith named parameter syntax. Calling this method will setdebugtotrue. -
setIncremental
Configure the java compilation to be incremental (e.g. compiles only those java classes that were changed or that are dependencies to the changed classes). -
isIncremental
informs whether to use incremental compilation feature. SeesetIncremental(boolean) -
getIncrementalAfterFailure
Used to enable or disable incremental compilation after a failure.By default, incremental compilation after a failure is enabled for Java and Groovy. It has no effect for Scala. It has no effect if incremental compilation is not enabled.
When the Java command line compiler is used, i.e. when a custom java home is passed to forkOptions.javaHome or javac is passed to forkOptions.executable, this optimization is automatically disabled, since the compiler is not invoked via the compiler API.
- Since:
- 7.6
-
getSourcepath
@Optional @Nullable @IgnoreEmptyDirectories @PathSensitive(RELATIVE) @InputFiles public FileCollection getSourcepath()The source path to use for the compilation.The source path indicates the location of source files that may be compiled if necessary. It is effectively a complement to the class path, where the classes to be compiled against are in source form. It does not indicate the actual primary source being compiled.
The source path feature of the Java compiler is rarely needed for modern builds that use dependency management.
The default value for the source path is
null, which indicates an empty source path. Note that this is different to the default value for the-sourcepathoption forjavac, which is to use the value specified by-classpath. If you wish to use any source path, it must be explicitly set.- Returns:
- the source path
- See Also:
-
setSourcepath
Sets the source path to use for the compilation.- Parameters:
sourcepath- the source path
-
getAnnotationProcessorPath
Returns the classpath to use to load annotation processors. This path is also used for annotation processor discovery.- Returns:
- The annotation processor path, or
nullif annotation processing is disabled. - Since:
- 3.4
-
setAnnotationProcessorPath
Set the classpath to use to load annotation processors. This path is also used for annotation processor discovery.- Parameters:
annotationProcessorPath- The annotation processor path, ornullto disable annotation processing.- Since:
- 3.4
-
getRelease
Configures the Java language version for this compile task (--releasecompiler flag).If set, it will take precedences over the
AbstractCompile.getSourceCompatibility()andAbstractCompile.getTargetCompatibility()settings.This option is only taken into account by the
JavaCompiletask.- Since:
- 6.6
-
getJavaModuleVersion
Set the version of the Java module.- Since:
- 6.4
-
getJavaModuleMainClass
Set the main class of the Java module, if the module is supposed to be executable.- Since:
- 6.4
-
getGeneratedSourceOutputDirectory
Returns the directory to place source files generated by annotation processors.- Since:
- 6.3
-
getAnnotationProcessorGeneratedSourcesDirectory
@Nullable @Deprecated @ReplacedBy("generatedSourceOutputDirectory") public File getAnnotationProcessorGeneratedSourcesDirectory()Deprecated.UsegetGeneratedSourceOutputDirectory()instead. This method will be removed in Gradle 9.0.Returns the directory to place source files generated by annotation processors.- Since:
- 4.3
-
setAnnotationProcessorGeneratedSourcesDirectory
Deprecated.UsegetGeneratedSourceOutputDirectory().set() instead. This method will be removed in Gradle 9.0.Sets the directory to place source files generated by annotation processors.- Since:
- 4.3
-
setAnnotationProcessorGeneratedSourcesDirectory
Deprecated.UsegetGeneratedSourceOutputDirectory().set() instead. This method will be removed in Gradle 9.0.Sets the directory to place source files generated by annotation processors.- Since:
- 4.3
-
getHeaderOutputDirectory
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.- Since:
- 4.10
-