API Documentation: | CompileOptions |
---|
Main options for Java compilation.
Property | Description |
bootClasspath | The bootstrap classpath to be used for the compiler process.
Only takes effect if |
compiler | Deprecated The compiler to be used. Only takes effect if |
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.
Only takes effect if |
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. |
includeJavaRuntime | Deprecated Tells whether the Java runtime should be put on the compile class path. Only takes effect if
|
listFiles | Tells whether to log the files to be compiled. Defaults to |
optimize | Deprecated Tells whether to produce optimized byte code. Only takes effect if |
useAnt | Deprecated Tells whether to use the Ant javac task over Gradle's own Java compiler integration.
Defaults to |
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 |
String
bootClasspath
The bootstrap classpath to be used for the compiler process.
Only takes effect if fork
is true
. Defaults to null
.
- Default:
null
String
compiler
Note: This property is deprecated and will be removed in the next major version of Gradle.
The compiler to be used. Only takes effect if useAnt
is true
.
- 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.
Only takes effect if fork
is true
. 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 deprecated and will be removed in the next major version of Gradle.
Tells whether the Java runtime should be put on the compile class path. Only takes effect if
useAnt
is true
. Defaults to false
.
- Default:
false
Note: This property is deprecated and will be removed in the next major version of Gradle.
Tells whether to produce optimized byte code. Only takes effect if useAnt
is true
.
Note that this flag is ignored by Sun's javac starting with JDK 1.3.
- Default:
false
Note: This property is deprecated and will be removed in the next major version of Gradle.
Tells whether to use the Ant javac task over Gradle's own Java compiler integration.
Defaults to false
.
- Default:
false
Tells whether to use the Ant <depend>
task.
Only takes effect if useAnt
is true
. Defaults to
false
.
- Default:
false
Method | Description |
debug(debugArgs) | Convenience method to set |
depend(dependArgs) | Convenience method to set |
fork(forkArgs) | Convenience method to set |
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
.