API Documentation: | CompileOptions |
---|
Main options for Java compilation.
Property | Description |
bootClasspath | 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. |
debug | Tells whether to include debugging information in the generated class files. Defaults
to |
debugOptions | Returns options for generating debugging information. |
dependOptions | Returns options for using the Ant |
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. |
incremental | Incubating informs whether to use experimental incremental compilation feature. See |
listFiles | Tells whether to log the files to be compiled. Defaults to |
sourcepath | Incubating The source path to use for the compilation. |
useDepend | Tells whether to use the Ant |
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 |
depend(dependArgs) | Convenience method to set |
fork(forkArgs) | Convenience method to set |
String
bootClasspath
The bootstrap classpath to be used for the compiler process. Defaults to null
.
- Default:
null
Returns any additional arguments to be passed to the compiler. Defaults to the empty list.
- Default:
[]
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:
true
DebugOptions
debugOptions
Returns options for generating debugging information.
DependOptions
dependOptions
Returns options for using the Ant <depend>
task.
Tells whether to log details of usage of deprecated members or classes. Defaults to false
.
- Default:
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:
null
String
extensionDirs
The extension dirs to be used for the compiler process. Defaults to null
.
- Default:
null
Tells whether to fail the build when compilation fails. Defaults to true
.
- Default:
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:
false
ForkOptions
forkOptions
Returns options for running the compiler in a child process.
Note: This property is incubating and may change in a future version of Gradle.
informs whether to use experimental incremental compilation feature. See CompileOptions.setIncremental(boolean)
- Default:
false
FileCollection
sourcepath
Note: This property is incubating and may change in a future version of Gradle.
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:
null
Tells whether to use the Ant <depend>
task.
Only takes effect if useAnt
is true
. Defaults to
false
.
- Default:
false
CompileOptions
debug
(Map
<String
, Object
>
debugArgs)
Map
<String
, Object
>Convenience method to set DebugOptions
with named parameter syntax.
Calling this method will set debug
to true
.
CompileOptions
depend
(Map
<String
, Object
>
dependArgs)
Map
<String
, Object
>Convenience method to set DependOptions
with named parameter syntax.
Calling this method will set useDepend
to true
.
CompileOptions
fork
(Map
<String
, Object
>
forkArgs)
Map
<String
, Object
>Convenience method to set ForkOptions
with named parameter syntax.
Calling this method will set fork
to true
.