Apache Maven Compiler Plugin – compiler:compile (original) (raw)

Compiles application sources. By default uses the javac compiler of the JDK used to execute Maven. This can be overwritten through Toolchains or parameter compilerId.
See also: javac Command

Parameter Details

Classpath elements to supply as annotation processor path. If specified, the compiler will detect annotation processors only in those classpath elements. If omitted, the default classpath is used to detect annotation processors. The detection itself depends on the configuration of annotationProcessors.

Each classpath element is specified using their Maven coordinates (groupId, artifactId, version, classifier, type). Transitive dependencies are added automatically. Exclusions are supported as well. Example:

org.sample sample-annotation-processor 1.2.3 org.sample sample-dependency

Note: Exclusions are supported from version 3.11.0.
See also: javac -processorpath, javac Annotation Processing

Whether to use the Maven dependency management section when resolving transitive dependencies of annotation processor paths.

This flag does not enable / disable the ability to resolve the version of annotation processor paths from dependency management section. It only influences the resolution of transitive dependencies of those top-level paths.

The source directories containing the sources to be compiled.

Sets the arguments to be passed to the compiler.

Note that -J options are only passed through if fork is set to true.

Example:

-Xmaxerrs 1000 -Xlint -J-Duser.language=en_us

See also: javac -J

Sets the unformatted single argument string to be passed to the compiler. To pass multiple arguments such as -Xmaxerrs 1000 (which are actually two arguments) you have to use compilerArgs.

This is because the list of valid arguments passed to a Java compiler varies based on the compiler version.

Note that -J options are only passed through if fork is set to true.

See also: javac -J

Deprecated.
use compilerArgs instead.

Sets the arguments to be passed to the compiler (prepending a dash).

This is because the list of valid arguments passed to a Java compiler varies based on the compiler version.

Note that -J options are only passed through if fork is set to true.

To pass -Xmaxerrs 1000 -Xlint -Xlint:-path -Averbose=true you should include the following:

1000 true

The compiler id of the compiler to use. See this guide for more information.

Strategy to re use javacc class created:

Note this parameter value depends on the os/jdk you are using, but the default value should work on most of env.

Deprecated.
This parameter is no longer evaluated by the underlying compilers, instead the actual version of the javac binary is automatically retrieved.

Version of the compiler to use, ex. "1.3", "1.5", if fork is set to true.

Package info source files that only contain javadoc and no annotation on the package can lead to no class file being generated by the compiler. This causes a file miss on the next compilations and forces an unnecessary recompilation. The default value of true causes an empty class file to be generated. This behavior can be changed by setting this parameter to false.

Set to true to include debugging information in the compiled class files.
See also: javac -g, debuglevel

When both fork and debug are enabled the commandline arguments used will be dumped to this file.

Keyword list to be appended to the -g command-line switch. Legal values are none or a comma-separated list of the following keywords: lines, vars, and source. If debug level is not specified, by default, nothing will be appended to -g. If debug is not turned on, this attribute will be ignored.
See also: javac -G:[lines,vars,source]

Set to true to enable preview language features of the java compiler
See also: javac --enable-preview

The -encoding argument for the Java compiler.
See also: javac -encoding

A list of exclusion filters for the compiler.

Sets the executable of the compiler to use when fork is true.

Indicates whether the build will continue even if there are compilation errors.

Indicates whether the build will continue even if there are compilation warnings.

File extensions to check timestamp for incremental build.

Deprecated.
Use forceLegacyJavacApi instead

Legacy parameter name of forceLegacyJavacApi. Only considered if forceLegacyJavacApi is not set or false.

The underlying compiler now uses javax.tools API if available in your current JDK. Set this to true to always use the legacy com.sun.tools.javac API instead.

This only has an effect for compilerId being javac and fork being false.

Allows running the compiler in a separate process. If false it uses the built in compiler, while if true it will use an executable.

Specify where to place generated source files created by annotation processing. Only applies to JDK 1.6+

Keyword to be appended to the -implicit: command-line switch.
See also: javac -implicit

A list of inclusion filters for the compiler.

A list of exclusion filters for the incremental calculation.

Specify the requirements for this jdk toolchain for using a different javac than the one of the JRE used by Maven. This overrules the toolchain selected by the maven-toolchain-plugin.

(see Guide to Toolchains for more info)

11 ... 1.8 zulu ...

note: requires at least Maven 3.3.1

Sets the maximum size, in megabytes, of the memory allocation pool, ex. "128", "128m" if fork is set to true.

Initial size, in megabytes, of the memory allocation pool, ex. "64", "64m" if fork is set to true.

The --module-version argument for the Java compiler. This is ignored if not applicable, e.g., in non-modular projects.
See also: javac --module-version

When set to true, the classes will be placed in META-INF/versions/${release} The release value must be set, otherwise the plugin will fail.

Note: A jar is only a multirelease jar if META-INF/MANIFEST.MF contains Multi-Release: true. You need to set this by configuring the maven-jar-plugin. This implies that you cannot test a multirelease jar using the outputDirectory.

Deprecated.
This property is a no-op in javac.

Set to true to optimize the compiled code using the compiler's optimization methods.

The directory for compiled classes.

This parameter should only be modified in special cases. One example is creating a multi-release jar with a lower bytecode level (i.e. setting it to ${project.build.outputDirectory/META-INF/versions/21} or similar) in an additional execution.

When the required bytecode level is available though an installed JDK or toolchain, it is recommended to use the <release> property in conjunction with the ${multiReleaseOutput} parameter instead.

Sets the name of the output file when compiling a set of sources to a single file.

expression="${project.build.finalName}"

Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).

Set to true to generate metadata for reflection on method parameters.
See also: javac -parameters

Sets whether annotation processing is performed or not. Only applies to JDK 1.6+ If not set, both compilation and annotation processing are performed at the same time.

Allowed values are:

full is the default. Starting with JDK 21, this option must be set explicitly.
See also: javac -proc, javac Annotation Processing

The -release argument for the Java compiler, supported since Java9
See also: javac -release

No description.

Sets whether to show source locations where deprecated APIs are used.

Set to false to disable warnings during compilation.

Set this to true to bypass compilation of main sources. Its use is NOT RECOMMENDED, but quite convenient on occasion.

No description.

The -source argument for the Java compiler.

NOTE:

Since 3.8.0 the default value has changed from 1.5 to 1.6

Since 3.9.0 the default value has changed from 1.6 to 1.7

Since 3.11.0 the default value has changed from 1.7 to 1.8

See also: javac -source

Sets the granularity in milliseconds of the last modification date for testing whether a source needs recompilation.

The -target argument for the Java compiler.

NOTE:

Since 3.8.0 the default value has changed from 1.5 to 1.6

Since 3.9.0 the default value has changed from 1.6 to 1.7

Since 3.11.0 the default value has changed from 1.7 to 1.8

See also: javac -target

to enable/disable incremental compilation feature.

This leads to two different modes depending on the underlying compiler. The default javac compiler does the following:

Set to true to show messages about what the compiler is doing.
See also: javac -verbose