compiler:testCompile
Full name:
org.apache.maven.plugins:maven-compiler-plugin:3.11.0:testCompile
Description:
Attributes:
- Requires a Maven project to be executed.
- Requires dependency resolution of artifacts in scope:
test
. - The goal is thread-safe and supports parallel builds.
- Since version:
2.0
. - Binds by default to the lifecycle phase:
test-compile
.
Optional Parameters
Name | Type | Since | Description |
---|---|---|---|
<annotationProcessorPaths> |
List<DependencyCoordinate> |
3.5 |
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 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: <configuration> <annotationProcessorPaths> <path> <groupId>org.sample</groupId> <artifactId>sample-annotation-processor</artifactId> <version>1.2.3</version> <!-- Optionally exclude transitive dependencies --> <exclusions> <exclusion> <groupId>org.sample</groupId> <artifactId>sample-dependency</artifactId> </exclusion> </exclusions> </path> <!-- ... more ... --> </annotationProcessorPaths> </configuration> |
<annotationProcessors> |
String[] |
2.2 |
Names of annotation processors to run. Only applies to JDK 1.6+ If not set, the default annotation processors discovery process applies. |
<compilerArgs> |
List<String> |
3.1 |
Sets the arguments to be passed to the compiler. Note that <compilerArgs> <arg>-Xmaxerrs</arg> <arg>1000</arg> <arg>-Xlint</arg> <arg>-J-Duser.language=en_us</arg> </compilerArgs> |
<compilerArgument> |
String |
- |
Sets the unformatted single argument string to be passed to the compiler. To pass multiple arguments such as This is because the list of valid arguments passed to a Java compiler varies based on the compiler version. Note that |
<compilerArguments> |
Map<String,String> |
2.0.1 |
Deprecated.
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 To pass <compilerArguments> <Xmaxerrs>1000</Xmaxerrs> <Xlint/> <Xlint:-path/> <Averbose>true</Averbose> </compilerArguments> |
<compilerId> |
String |
- |
The compiler id of the compiler to use. See this guide for more information. Default value is: javac .User property is: maven.compiler.compilerId . |
<compilerReuseStrategy> |
String |
2.5 |
Strategy to re use javacc class created:
Default value is: ${reuseCreated} .User property is: maven.compiler.compilerReuseStrategy . |
<compilerVersion> |
String |
- |
Version of the compiler to use, ex. "1.3", "1.5", if fork is set to true .User property is: maven.compiler.compilerVersion . |
<createMissingPackageInfoClass> |
boolean |
3.10 |
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 .Default value is: true .User property is: maven.compiler.createMissingPackageInfoClass . |
<debug> |
boolean |
- |
Set to true to include debugging information in the compiled class files.Default value is: true .User property is: maven.compiler.debug . |
<debugFileName> |
String |
3.10.0 |
when forking and debug activated the commandline used will be dumped in this file Default value is: javac-test . |
<debuglevel> |
String |
2.1 |
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.User property is: maven.compiler.debuglevel . |
<enablePreview> |
boolean |
3.10.1 |
Set to true to Enable preview language features of the java compilerDefault value is: false .User property is: maven.compiler.enablePreview . |
<encoding> |
String |
2.1 |
The -encoding argument for the Java compiler. Default value is: ${project.build.sourceEncoding} .User property is: encoding . |
<executable> |
String |
- |
Sets the executable of the compiler to use when fork is true .User property is: maven.compiler.executable . |
<failOnError> |
boolean |
2.0.2 |
Indicates whether the build will continue even if there are compilation errors. Default value is: true .User property is: maven.compiler.failOnError . |
<failOnWarning> |
boolean |
3.6 |
Indicates whether the build will continue even if there are compilation warnings. Default value is: false .User property is: maven.compiler.failOnWarning . |
<fileExtensions> |
List<String> |
3.1 |
File extensions to check timestamp for incremental build. Default contains only class and jar . |
<forceJavacCompilerUse> |
boolean |
3.0 |
compiler can now use javax.tools if available in your current jdk, you can disable this feature using -Dmaven.compiler.forceJavacCompilerUse=true or in the plugin configuration Default value is: false .User property is: maven.compiler.forceJavacCompilerUse . |
<fork> |
boolean |
- |
Allows running the compiler in a separate process. If false it uses the built in compiler, while if true it will use an executable.Default value is: false .User property is: maven.compiler.fork . |
<generatedTestSourcesDirectory> |
File |
2.2 |
Specify where to place generated source files created by annotation processing. Only applies to JDK 1.6+ Default value is: ${project.build.directory}/generated-test-sources/test-annotations . |
<implicit> |
String |
3.10.2 |
Keyword to be appended to the -implicit: command-line switch.User property is: maven.compiler.implicit . |
<jdkToolchain> |
Map<String,String> |
3.6 |
Specify the requirements for this jdk toolchain for using a different <configuration> <jdkToolchain> <version>11</version> </jdkToolchain> ... </configuration> <configuration> <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> ... </configuration> |
<maxmem> |
String |
2.0.1 |
Sets the maximum size, in megabytes, of the memory allocation pool, ex. "128", "128m" if fork is set to true .User property is: maven.compiler.maxmem . |
<meminitial> |
String |
2.0.1 |
Initial size, in megabytes, of the memory allocation pool, ex. "64", "64m" if fork is set to true .User property is: maven.compiler.meminitial . |
<optimize> |
boolean |
- |
Deprecated. Set to true to optimize the compiled code using the compiler's optimization methods.Default value is: false .User property is: maven.compiler.optimize . |
<outputFileName> |
String |
- |
Sets the name of the output file when compiling a set of sources to a single file.
expression="${project.build.finalName}" |
<parameters> |
boolean |
3.6.2 |
Set to true to generate metadata for reflection on method parameters.Default value is: false .User property is: maven.compiler.parameters . |
<proc> |
String |
2.2 |
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:
|
<release> |
String |
3.6 |
The -release argument for the Java compiler, supported since Java9 User property is: maven.compiler.release . |
<showCompilationChanges> |
boolean |
- |
(no description) Default value is: false .User property is: maven.compiler.showCompilationChanges . |
<showDeprecation> |
boolean |
- |
Sets whether to show source locations where deprecated APIs are used. Default value is: false .User property is: maven.compiler.showDeprecation . |
<showWarnings> |
boolean |
- |
Set to false to disable warnings during compilation.Default value is: true .User property is: maven.compiler.showWarnings . |
<skip> |
boolean |
- |
Set this to 'true' to bypass compilation of test sources. Its use is NOT RECOMMENDED, but quite convenient on occasion. User property is: maven.test.skip . |
<skipMultiThreadWarning> |
boolean |
2.5 |
(no description) Default value is: false .User property is: maven.compiler.skipMultiThreadWarning . |
<source> |
String |
- |
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 Default value is: 1.8 .User property is: maven.compiler.source . |
<staleMillis> |
int |
- |
Sets the granularity in milliseconds of the last modification date for testing whether a source needs recompilation. Default value is: 0 .User property is: lastModGranularityMs . |
<target> |
String |
- |
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 Default value is: 1.8 .User property is: maven.compiler.target . |
<testCompilerArgument> |
String |
2.1 |
Sets the unformatted argument string to be passed to test compiler if fork is set to true. This is because the list of valid arguments passed to a Java compiler varies based on the compiler version. |
<testCompilerArguments> |
Map<String,String> |
2.1 |
Sets the arguments to be passed to test compiler (prepending a dash) if fork is set to true. This is because the list of valid arguments passed to a Java compiler varies based on the compiler version. |
<testExcludes> |
Set<String> |
- |
A list of exclusion filters for the compiler. |
<testIncludes> |
Set<String> |
- |
A list of inclusion filters for the compiler. |
<testIncrementalExcludes> |
Set<String> |
3.11 |
A list of exclusion filters for the incremental calculation. |
<testRelease> |
String |
3.6 |
the -release argument for the test Java compiler User property is: maven.compiler.testRelease . |
<testSource> |
String |
2.1 |
The -source argument for the test Java compiler. User property is: maven.compiler.testSource . |
<testTarget> |
String |
2.1 |
The -target argument for the test Java compiler. User property is: maven.compiler.testTarget . |
<useIncrementalCompilation> |
boolean |
3.1 |
to enable/disable incremental compilation feature. This leads to two different modes depending on the underlying compiler. The default javac compiler does the following:
Default value is: true .User property is: maven.compiler.useIncrementalCompilation . |
<useModulePath> |
boolean |
3.11 |
When Default value is: true . |
<verbose> |
boolean |
- |
Set to true to show messages about what the compiler is doing.Default value is: false .User property is: maven.compiler.verbose . |
Parameter Details
<annotationProcessorPaths>
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:
<configuration> <annotationProcessorPaths> <path> <groupId>org.sample</groupId> <artifactId>sample-annotation-processor</artifactId> <version>1.2.3</version> <!-- Optionally exclude transitive dependencies --> <exclusions> <exclusion> <groupId>org.sample</groupId> <artifactId>sample-dependency</artifactId> </exclusion> </exclusions> </path> <!-- ... more ... --> </annotationProcessorPaths> </configuration>
- Type:
java.util.List<org.apache.maven.plugin.compiler.DependencyCoordinate>
- Since:
3.5
- Required:
No
<annotationProcessors>
Names of annotation processors to run. Only applies to JDK 1.6+ If not set, the default annotation processors discovery process applies.
- Type:
java.lang.String[]
- Since:
2.2
- Required:
No
<compilerArgs>
Sets the arguments to be passed to the compiler.
Note that -J
options are only passed through if fork
is set to true
.
<compilerArgs> <arg>-Xmaxerrs</arg> <arg>1000</arg> <arg>-Xlint</arg> <arg>-J-Duser.language=en_us</arg> </compilerArgs>
- Type:
java.util.List<java.lang.String>
- Since:
3.1
- Required:
No
<compilerArgument>
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 compilerArguments
.
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
.
- Type:
java.lang.String
- Required:
No
<compilerArguments>
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:
<compilerArguments> <Xmaxerrs>1000</Xmaxerrs> <Xlint/> <Xlint:-path/> <Averbose>true</Averbose> </compilerArguments>
- Type:
java.util.Map<java.lang.String, java.lang.String>
- Since:
2.0.1
- Required:
No
<compilerId>
- Type:
java.lang.String
- Required:
No
- User Property:
maven.compiler.compilerId
- Default:
javac
<compilerReuseStrategy>
reuseCreated
(default): will reuse already created but in case of multi-threaded builds, each thread will have its own instancereuseSame
: the same Javacc class will be used for each compilation even for multi-threaded buildalwaysNew
: a new Javacc class will be created for each compilation
- Type:
java.lang.String
- Since:
2.5
- Required:
No
- User Property:
maven.compiler.compilerReuseStrategy
- Default:
${reuseCreated}
<compilerVersion>
fork
is set to true
.- Type:
java.lang.String
- Required:
No
- User Property:
maven.compiler.compilerVersion
<createMissingPackageInfoClass>
true
causes an empty class file to be generated. This behavior can be changed by setting this parameter to false
.- Type:
boolean
- Since:
3.10
- Required:
No
- User Property:
maven.compiler.createMissingPackageInfoClass
- Default:
true
<debug>
true
to include debugging information in the compiled class files.- Type:
boolean
- Required:
No
- User Property:
maven.compiler.debug
- Default:
true
<debugFileName>
- Type:
java.lang.String
- Since:
3.10.0
- Required:
No
- Default:
javac-test
<debuglevel>
-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.- Type:
java.lang.String
- Since:
2.1
- Required:
No
- User Property:
maven.compiler.debuglevel
<enablePreview>
true
to Enable preview language features of the java compiler- Type:
boolean
- Since:
3.10.1
- Required:
No
- User Property:
maven.compiler.enablePreview
- Default:
false
<encoding>
- Type:
java.lang.String
- Since:
2.1
- Required:
No
- User Property:
encoding
- Default:
${project.build.sourceEncoding}
<executable>
fork
is true
.- Type:
java.lang.String
- Required:
No
- User Property:
maven.compiler.executable
<failOnError>
- Type:
boolean
- Since:
2.0.2
- Required:
No
- User Property:
maven.compiler.failOnError
- Default:
true
<failOnWarning>
- Type:
boolean
- Since:
3.6
- Required:
No
- User Property:
maven.compiler.failOnWarning
- Default:
false
<fileExtensions>
class
and jar
.- Type:
java.util.List<java.lang.String>
- Since:
3.1
- Required:
No
<forceJavacCompilerUse>
- Type:
boolean
- Since:
3.0
- Required:
No
- User Property:
maven.compiler.forceJavacCompilerUse
- Default:
false
<fork>
false
it uses the built in compiler, while if true
it will use an executable.- Type:
boolean
- Required:
No
- User Property:
maven.compiler.fork
- Default:
false
<generatedTestSourcesDirectory>
Specify where to place generated source files created by annotation processing. Only applies to JDK 1.6+
- Type:
java.io.File
- Since:
2.2
- Required:
No
- Default:
${project.build.directory}/generated-test-sources/test-annotations
<implicit>
-implicit:
command-line switch.- Type:
java.lang.String
- Since:
3.10.2
- Required:
No
- User Property:
maven.compiler.implicit
<jdkToolchain>
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.
<configuration> <jdkToolchain> <version>11</version> </jdkToolchain> ... </configuration> <configuration> <jdkToolchain> <version>1.8</version> <vendor>zulu</vendor> </jdkToolchain> ... </configuration>
- Type:
java.util.Map<java.lang.String, java.lang.String>
- Since:
3.6
- Required:
No
<maxmem>
fork
is set to true
.- Type:
java.lang.String
- Since:
2.0.1
- Required:
No
- User Property:
maven.compiler.maxmem
<meminitial>
fork
is set to true
.- Type:
java.lang.String
- Since:
2.0.1
- Required:
No
- User Property:
maven.compiler.meminitial
<optimize>
javac
.true
to optimize the compiled code using the compiler's optimization methods.- Type:
boolean
- Required:
No
- User Property:
maven.compiler.optimize
- Default:
false
<outputFileName>
- Type:
java.lang.String
- Required:
No
<parameters>
true
to generate metadata for reflection on method parameters.- Type:
boolean
- Since:
3.6.2
- Required:
No
- User Property:
maven.compiler.parameters
- Default:
false
<proc>
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:
none
- no annotation processing is performed.only
- only annotation processing is done, no compilation.
- Type:
java.lang.String
- Since:
2.2
- Required:
No
<release>
- Type:
java.lang.String
- Since:
3.6
- Required:
No
- User Property:
maven.compiler.release
<showCompilationChanges>
- Type:
boolean
- Required:
No
- User Property:
maven.compiler.showCompilationChanges
- Default:
false
<showDeprecation>
- Type:
boolean
- Required:
No
- User Property:
maven.compiler.showDeprecation
- Default:
false
<showWarnings>
false
to disable warnings during compilation.- Type:
boolean
- Required:
No
- User Property:
maven.compiler.showWarnings
- Default:
true
<skip>
- Type:
boolean
- Required:
No
- User Property:
maven.test.skip
<skipMultiThreadWarning>
- Type:
boolean
- Since:
2.5
- Required:
No
- User Property:
maven.compiler.skipMultiThreadWarning
- Default:
false
<source>
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
- Type:
java.lang.String
- Required:
No
- User Property:
maven.compiler.source
- Default:
1.8
<staleMillis>
- Type:
int
- Required:
No
- User Property:
lastModGranularityMs
- Default:
0
<target>
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
- Type:
java.lang.String
- Required:
No
- User Property:
maven.compiler.target
- Default:
1.8
<testCompilerArgument>
Sets the unformatted argument string to be passed to test compiler if fork is set to true.
This is because the list of valid arguments passed to a Java compiler varies based on the compiler version.
- Type:
java.lang.String
- Since:
2.1
- Required:
No
<testCompilerArguments>
Sets the arguments to be passed to test compiler (prepending a dash) if fork is set to true.
This is because the list of valid arguments passed to a Java compiler varies based on the compiler version.
- Type:
java.util.Map<java.lang.String, java.lang.String>
- Since:
2.1
- Required:
No
<testExcludes>
- Type:
java.util.Set<java.lang.String>
- Required:
No
<testIncludes>
- Type:
java.util.Set<java.lang.String>
- Required:
No
<testIncrementalExcludes>
- Type:
java.util.Set<java.lang.String>
- Since:
3.11
- Required:
No
<testRelease>
- Type:
java.lang.String
- Since:
3.6
- Required:
No
- User Property:
maven.compiler.testRelease
<testSource>
- Type:
java.lang.String
- Since:
2.1
- Required:
No
- User Property:
maven.compiler.testSource
<testTarget>
- Type:
java.lang.String
- Since:
2.1
- Required:
No
- User Property:
maven.compiler.testTarget
<useIncrementalCompilation>
to enable/disable incremental compilation feature.
This leads to two different modes depending on the underlying compiler. The default javac compiler does the following:
- true (default) in this mode the compiler plugin determines whether any JAR files the current module depends on have changed in the current build run; or any source file was added, removed or changed since the last compilation. If this is the case, the compiler plugin recompiles all sources.
- false (not recommended) this only compiles source files which are newer than their corresponding class files, namely which have changed since the last compilation. This does not recompile other classes which use the changed class, potentially leaving them with references to methods that no longer exist, leading to errors at runtime.
- Type:
boolean
- Since:
3.1
- Required:
No
- User Property:
maven.compiler.useIncrementalCompilation
- Default:
true
<useModulePath>
When true
, uses the module path when compiling with a release or target of 9+ and module-info.java or module-info.class is present. When false
, always uses the class path.
- Type:
boolean
- Since:
3.11
- Required:
No
- Default:
true
<verbose>
true
to show messages about what the compiler is doing.- Type:
boolean
- Required:
No
- User Property:
maven.compiler.verbose
- Default:
false