org.gradle.api.tasks.compile.CompileOptions Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Show all versions of gradle-api Show documentation
Gradle 6.9.1 API redistribution.
/*
* Copyright 2007 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gradle.api.tasks.compile;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Lists;
import org.gradle.api.Incubating;
import org.gradle.api.Nullable;
import org.gradle.api.file.FileCollection;
import org.gradle.api.tasks.Console;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.Internal;
import org.gradle.api.tasks.Nested;
import org.gradle.api.tasks.Optional;
import org.gradle.util.DeprecationLogger;
import java.util.List;
import java.util.Map;
/**
* Main options for Java compilation.
*/
public class CompileOptions extends AbstractOptions {
private static final long serialVersionUID = 0;
private static final ImmutableSet EXCLUDE_FROM_ANT_PROPERTIES =
ImmutableSet.of("debugOptions", "forkOptions", "compilerArgs", "dependOptions", "useDepend", "incremental");
private boolean failOnError = true;
private boolean verbose;
private boolean listFiles;
private boolean deprecation;
private boolean warnings = true;
private String encoding;
private boolean debug = true;
private DebugOptions debugOptions = new DebugOptions();
private boolean fork;
private ForkOptions forkOptions = new ForkOptions();
private boolean useDepend;
@SuppressWarnings("deprecation")
private DependOptions dependOptions = new DependOptions();
private String bootClasspath;
private String extensionDirs;
private List compilerArgs = Lists.newArrayList();
private boolean incremental;
private FileCollection sourcepath;
private FileCollection annotationProcessorPath;
/**
* Tells whether to fail the build when compilation fails. Defaults to {@code true}.
*/
@Input
public boolean isFailOnError() {
return failOnError;
}
/**
* Sets whether to fail the build when compilation fails. Defaults to {@code true}.
*/
public void setFailOnError(boolean failOnError) {
this.failOnError = failOnError;
}
/**
* Tells whether to produce verbose output. Defaults to {@code false}.
*/
@Console
public boolean isVerbose() {
return verbose;
}
/**
* Sets whether to produce verbose output. Defaults to {@code false}.
*/
public void setVerbose(boolean verbose) {
this.verbose = verbose;
}
/**
* Tells whether to log the files to be compiled. Defaults to {@code false}.
*/
@Console
public boolean isListFiles() {
return listFiles;
}
/**
* Sets whether to log the files to be compiled. Defaults to {@code false}.
*/
public void setListFiles(boolean listFiles) {
this.listFiles = listFiles;
}
/**
* Tells whether to log details of usage of deprecated members or classes. Defaults to {@code false}.
*/
@Console
public boolean isDeprecation() {
return deprecation;
}
/**
* Sets whether to log details of usage of deprecated members or classes. Defaults to {@code false}.
*/
public void setDeprecation(boolean deprecation) {
this.deprecation = deprecation;
}
/**
* Tells whether to log warning messages. The default is {@code true}.
*/
@Console
public boolean isWarnings() {
return warnings;
}
/**
* Sets whether to log warning messages. The default is {@code true}.
*/
public void setWarnings(boolean warnings) {
this.warnings = warnings;
}
/**
* Returns the character encoding to be used when reading source files. Defaults to {@code null}, in which
* case the platform default encoding will be used.
*/
@Input
@Optional
public String getEncoding() {
return encoding;
}
/**
* Sets the character encoding to be used when reading source files. Defaults to {@code null}, in which
* case the platform default encoding will be used.
*/
public void setEncoding(String encoding) {
this.encoding = encoding;
}
/**
* Tells whether to include debugging information in the generated class files. Defaults
* to {@code true}. See {@link DebugOptions#getDebugLevel()} for which debugging information will be generated.
*/
@Input
public boolean isDebug() {
return debug;
}
/**
* Sets whether to include debugging information in the generated class files. Defaults
* to {@code true}. See {@link DebugOptions#getDebugLevel()} for which debugging information will be generated.
*/
public void setDebug(boolean debug) {
this.debug = debug;
}
/**
* Returns options for generating debugging information.
*/
@Nested
public DebugOptions getDebugOptions() {
return debugOptions;
}
/**
* Sets options for generating debugging information.
*/
public void setDebugOptions(DebugOptions debugOptions) {
this.debugOptions = debugOptions;
}
/**
* 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 {@code false}.
*/
@Input
public boolean isFork() {
return 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 to {@code false}.
*/
public void setFork(boolean fork) {
this.fork = fork;
}
/**
* Returns options for running the compiler in a child process.
*/
@Nested
public ForkOptions getForkOptions() {
return forkOptions;
}
/**
* Sets options for running the compiler in a child process.
*/
public void setForkOptions(ForkOptions forkOptions) {
this.forkOptions = forkOptions;
}
/**
* Tells whether to use the Ant {@code } task.
* Only takes effect if {@code useAnt} is {@code true}. Defaults to
* {@code false}.
*/
@Input
@Deprecated
public boolean isUseDepend() {
DeprecationLogger.nagUserOfDiscontinuedMethod("CompileOptions.isUseDepend()");
return useDepend;
}
/**
* Sets whether to use the Ant {@code } task.
* Only takes effect if {@code useAnt} is {@code true}. Defaults to
* {@code false}.
*/
@Deprecated
public void setUseDepend(boolean useDepend) {
DeprecationLogger.nagUserOfDiscontinuedMethod("CompileOptions.setUseDepend()");
this.useDepend = useDepend;
}
/**
* Returns options for using the Ant {@code } task.
*/
@Nested
@Deprecated
public DependOptions getDependOptions() {
DeprecationLogger.nagUserOfDiscontinuedMethod("CompileOptions.getDependOptions()");
return dependOptions;
}
/**
* Sets options for using the Ant {@code } task.
*/
@Deprecated
public void setDependOptions(DependOptions dependOptions) {
DeprecationLogger.nagUserOfDiscontinuedMethod("CompileOptions.setDependOptions()");
this.dependOptions = dependOptions;
}
/**
* Returns the bootstrap classpath to be used for the compiler process. Defaults to {@code null}.
*/
@Input
@Optional
public String getBootClasspath() {
return bootClasspath;
}
/**
* Sets the bootstrap classpath to be used for the compiler process. Defaults to {@code null}.
*/
public void setBootClasspath(String bootClasspath) {
this.bootClasspath = bootClasspath;
}
/**
* Returns the extension dirs to be used for the compiler process. Defaults to {@code null}.
*/
@Input
@Optional
public String getExtensionDirs() {
return extensionDirs;
}
/**
* Sets the extension dirs to be used for the compiler process. Defaults to {@code null}.
*/
public void setExtensionDirs(String extensionDirs) {
this.extensionDirs = extensionDirs;
}
/**
* 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 {@code -release} option of JDK 9:
* compilerArgs.addAll(['-release', '7'])
*
* Note that if {@code -release} is added then {@code -target} and {@code -source}
* are ignored.
*/
@Input
public List getCompilerArgs() {
return compilerArgs;
}
/**
* Sets any additional arguments to be passed to the compiler.
* Defaults to the empty list.
*/
public void setCompilerArgs(List compilerArgs) {
this.compilerArgs = compilerArgs;
}
/**
* Convenience method to set {@link ForkOptions} with named parameter syntax.
* Calling this method will set {@code fork} to {@code true}.
*/
public CompileOptions fork(Map forkArgs) {
fork = true;
forkOptions.define(forkArgs);
return this;
}
/**
* Convenience method to set {@link DebugOptions} with named parameter syntax.
* Calling this method will set {@code debug} to {@code true}.
*/
public CompileOptions debug(Map debugArgs) {
debug = true;
debugOptions.define(debugArgs);
return this;
}
/**
* Convenience method to set {@link DependOptions} with named parameter syntax.
* Calling this method will set {@code useDepend} to {@code true}.
*/
@Deprecated
public CompileOptions depend(Map dependArgs) {
DeprecationLogger.nagUserOfDiscontinuedMethod("CompileOptions.depend()");
useDepend = true;
dependOptions.define(dependArgs);
return this;
}
/**
* 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).
*/
public CompileOptions setIncremental(boolean incremental) {
this.incremental = incremental;
return this;
}
/**
* Internal method.
*/
@Override
public Map optionMap() {
Map map = super.optionMap();
map.putAll(debugOptions.optionMap());
map.putAll(forkOptions.optionMap());
return map;
}
@Override
protected boolean excludeFromAntProperties(String fieldName) {
return EXCLUDE_FROM_ANT_PROPERTIES.contains(fieldName);
}
@Override
protected String getAntPropertyName(String fieldName) {
if (fieldName.equals("warnings")) {
return "nowarn";
}
if (fieldName.equals("extensionDirs")) {
return "extdirs";
}
return fieldName;
}
@Override
protected Object getAntPropertyValue(String fieldName, Object value) {
if (fieldName.equals("warnings")) {
return !warnings;
}
return value;
}
/**
* informs whether to use incremental compilation feature. See {@link #setIncremental(boolean)}
*/
@Input
public boolean isIncremental() {
return incremental;
}
/**
* 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 {@code null}, which indicates an empty source path.
* Note that this is different to the default value for the {@code -sourcepath} option for {@code javac}, which is to use the value specified by {@code -classpath}.
* If you wish to use any source path, it must be explicitly set.
*
* @return the source path
* @see #setSourcepath(FileCollection)
*/
@Input
@Optional
@Incubating
public FileCollection getSourcepath() {
return sourcepath;
}
/**
* Sets the source path to use for the compilation.
*
* @param sourcepath the source path
*/
@Incubating
public void setSourcepath(FileCollection sourcepath) {
this.sourcepath = sourcepath;
}
/**
* Returns the classpath to use to load annotation processors. This path is also used for annotation processor discovery. The default value is {@code null}, which means use the compile classpath.
*
* @return The annotation processor path, or {@code null} to use the default.
* @since 3.4
*/
@Optional
@Incubating
@Internal // Handled on the compile task
@Nullable
public FileCollection getAnnotationProcessorPath() {
return annotationProcessorPath;
}
/**
* Set the classpath to use to load annotation processors. This path is also used for annotation processor discovery. The value can be {@code null}, which means use the compile classpath.
*
* @param annotationProcessorPath The annotation processor path, or {@code null} to use the default.
* @since 3.4
*/
@Incubating
public void setAnnotationProcessorPath(@Nullable FileCollection annotationProcessorPath) {
this.annotationProcessorPath = annotationProcessorPath;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy