Table of Contents
| API Documentation: | CompileOptions |
|---|
Main options for Java compilation.
| Property | Description |
annotationProcessorGeneratedSourcesDirectory | Deprecated Replaced The directory to place source files generated by annotation processors. |
annotationProcessorPath | The classpath to use to load annotation processors. This path is also used for annotation processor discovery. |
bootstrapClasspath | The bootstrap classpath to be used for the compiler process. Defaults to |
compilerArgs | 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 |
compilerArgumentProviders | Compiler argument providers. |
debug | Tells whether to include debugging information in the generated class files. Defaults
to |
debugOptions | Returns options for generating debugging information. |
deprecation | Tells whether to log details of usage of deprecated members or classes. Defaults to |
encoding | The character encoding to be used when reading source files. Defaults to |
extensionDirs | The extension dirs to be used for the compiler process. Defaults to |
failOnError | Tells whether to fail the build when compilation fails. Defaults to |
fork | 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 to |
forkOptions | Returns options for running the compiler in a child process. |
generatedSourceOutputDirectory | The directory to place source files generated by annotation processors. |
headerOutputDirectory | 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. |
incremental | informs whether to use incremental compilation feature. See |
listFiles | Tells whether to log the files to be compiled. Defaults to |
release | Configures the Java language version for this compile task ( |
sourcepath | The source path to use for the compilation. |
verbose | Tells whether to produce verbose output. Defaults to |
warnings | Tells whether to log warning messages. The default is |
| Method | Description |
debug(debugArgs) | Convenience method to set |
fork(forkArgs) | Convenience method to set |
File annotationProcessorGeneratedSourcesDirectory
Note: This property is deprecated and will be removed in the next major version of Gradle.
Note: This property has been replaced by generatedSourceOutputDirectory.
The directory to place source files generated by annotation processors.
- Default with
javaplugin: ${project.layout.buildDirectory}/generated/sources/annotationProcessor/${sourceDirectorySet.name}/${sourceSet.name}
FileCollection annotationProcessorPath
The classpath to use to load annotation processors. This path is also used for annotation processor discovery.
- Default with
javaplugin: sourceSet.annotationProcessorPath
FileCollection bootstrapClasspath
The bootstrap classpath to be used for the compiler process. Defaults to null.
- Default with
javaplugin: null
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-preview option that was added in newer Java versions:
compilerArgs.add("--enable-preview")
Note that if --release is added then -target and -source
are ignored.
- Default with
javaplugin: []
List<CommandLineArgumentProvider>compilerArgumentProviders (read-only)
List<CommandLineArgumentProvider>Compiler argument providers.
- Default with
javaplugin: []
Tells whether to include debugging information in the generated class files. Defaults
to true. See DebugOptions.getDebugLevel() for which debugging information will be generated.
- Default with
javaplugin: true
DebugOptions debugOptions
Returns options for generating debugging information.
Tells whether to log details of usage of deprecated members or classes. Defaults to false.
- Default with
javaplugin: false
String encoding
The character encoding to be used when reading source files. Defaults to null, in which
case the platform default encoding will be used.
- Default with
javaplugin: null
String extensionDirs
The extension dirs to be used for the compiler process. Defaults to null.
- Default with
javaplugin: null
Tells whether to fail the build when compilation fails. Defaults to true.
- Default with
javaplugin: true
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 to false.
- Default with
javaplugin: false
ForkOptions forkOptions
Returns options for running the compiler in a child process.
DirectoryProperty generatedSourceOutputDirectory
The directory to place source files generated by annotation processors.
- Default with
javaplugin: ${project.layout.buildDirectory}/generated/sources/annotationProcessor/${sourceDirectorySet.name}/${sourceSet.name}
DirectoryProperty headerOutputDirectory
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.
- Default with
javaplugin: ${project.layout.buildDirectory}/generated/sources/headers/${sourceDirectorySet.name}/${sourceSet.name}
informs whether to use incremental compilation feature. See CompileOptions.setIncremental(boolean)
- Default with
javaplugin: true
Tells whether to log the files to be compiled. Defaults to false.
- Default with
javaplugin: false
Configures the Java language version for this compile task (--release compiler flag).
If set, it will take precedences over the AbstractCompile.getSourceCompatibility() and AbstractCompile.getTargetCompatibility() settings.
This option is only taken into account by the JavaCompile task.
FileCollection sourcepath
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 -sourcepath option for javac, which is to use the value specified by -classpath.
If you wish to use any source path, it must be explicitly set.
- Default with
javaplugin: null
Tells whether to produce verbose output. Defaults to false.
- Default with
javaplugin: false
CompileOptions debug(Map<String, Object>
Map<String, Object>Convenience method to set DebugOptions with named parameter syntax.
Calling this method will set debug to true.
CompileOptions fork(Map<String, Object>
Map<String, Object>Convenience method to set ForkOptions with named parameter syntax.
Calling this method will set fork to true.