Package org.apache.maven.plugin.compiler

Class AbstractCompilerMojo

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
    Direct Known Subclasses:
    CompilerMojo, TestCompilerMojo
    public abstract class AbstractCompilerMojo
extends org.apache.maven.plugin.AbstractMojo
    TODO: At least one step could be optimized, currently the plugin will do two scans of all the source code if the compiler has to have the entire set of sources. This is currently the case for at least the C# compiler and most likely all the other .NET compilers too.
    Since:
    2.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.List<DependencyCoordinate> annotationProcessorPaths
      Classpath elements to supply as annotation processor path.
      private boolean annotationProcessorPathsUseDepMgmt
      Whether to use the Maven dependency management section when resolving transitive dependencies of annotation processor paths.
      private java.lang.String[] annotationProcessors
      Names of annotation processors to run.
      private org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager
      Artifact handler manager.
      private java.io.File basedir
      The directory to run the compiler from if fork is true.
      private java.io.File buildDirectory
      The target directory of the compiler if fork is true.
      protected java.util.List<java.lang.String> compilerArgs
      Sets the arguments to be passed to the compiler.
      protected java.lang.String compilerArgument
      Sets the unformatted single argument string to be passed to the compiler.
      protected java.util.Map<java.lang.String,​java.lang.String> compilerArguments
      Deprecated.
      use compilerArgs instead.
      private java.lang.String compilerId
      The compiler id of the compiler to use.
      private org.codehaus.plexus.compiler.manager.CompilerManager compilerManager
      Plexus compiler manager.
      private java.lang.String compilerReuseStrategy
      Strategy to re use javacc class created: reuseCreated (default): will reuse already created but in case of multi-threaded builds, each thread will have its own instance reuseSame: the same Javacc class will be used for each compilation even for multi-threaded build alwaysNew: a new Javacc class will be created for each compilation Note this parameter value depends on the os/jdk you are using, but the default value should work on most of env.
      private java.lang.String compilerVersion
      Deprecated.
      This parameter is no longer evaluated by the underlying compilers, instead the actual version of the javac binary is automatically retrieved.
      private boolean createMissingPackageInfoClass
      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.
      private boolean debug
      Set to true to include debugging information in the compiled class files.
      private java.lang.String debuglevel
      Keyword list to be appended to the -g command-line switch.
      (package private) static java.lang.String DEFAULT_SOURCE  
      (package private) static java.lang.String DEFAULT_TARGET  
      private boolean enablePreview
      Set to true to enable preview language features of the java compiler
      private java.lang.String encoding
      The -encoding argument for the Java compiler.
      private java.lang.String executable
      Sets the executable of the compiler to use when fork is true.
      private boolean failOnError
      Indicates whether the build will continue even if there are compilation errors.
      private boolean failOnWarning
      Indicates whether the build will continue even if there are compilation warnings.
      private java.util.Set<java.lang.String> fileExtensions
      File extensions to check timestamp for incremental build.
      private boolean forceJavacCompilerUse
      Deprecated.
      Use forceLegacyJavacApi instead
      private boolean forceLegacyJavacApi
      The underlying compiler now uses javax.tools API if available in your current JDK.
      private boolean fork
      Allows running the compiler in a separate process.
      private java.lang.String implicit
      Keyword to be appended to the -implicit: command-line switch.
      private static java.lang.String INPUT_FILES_LST_FILENAME  
      private java.util.Map<java.lang.String,​java.lang.String> jdkToolchain
      Specify the requirements for this jdk toolchain for using a different javac than the one of the JRE used by Maven.
      private java.lang.String maxmem
      Sets the maximum size, in megabytes, of the memory allocation pool, ex.
      private java.lang.String meminitial
      Initial size, in megabytes, of the memory allocation pool, ex.
      private org.apache.maven.plugin.MojoExecution mojoExecution  
      private boolean optimize
      Deprecated.
      This property is a no-op in javac.
      private java.lang.String outputFileName
      Sets the name of the output file when compiling a set of sources to a single file.
      private java.lang.String outputTimestamp
      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).
      private boolean parameters
      Set to true to generate metadata for reflection on method parameters.
      private java.lang.String proc
      Sets whether annotation processing is performed or not.
      private org.apache.maven.project.MavenProject project
      The current project instance.
      protected static java.lang.String PS  
      protected java.lang.String release
      The -release argument for the Java compiler, supported since Java9
      private org.eclipse.aether.RepositorySystem repositorySystem
      Resolves the artifacts needed.
      private org.apache.maven.execution.MavenSession session
      The current build session instance.
      private boolean showCompilationChanges  
      private boolean showDeprecation
      Sets whether to show source locations where deprecated APIs are used.
      private boolean showWarnings
      Set to false to disable warnings during compilation.
      private boolean skipMultiThreadWarning  
      protected java.lang.String source
      The -source argument for the Java compiler.
      private int staleMillis
      Sets the granularity in milliseconds of the last modification date for testing whether a source needs recompilation.
      protected java.lang.String target
      The -target argument for the Java compiler.
      private boolean targetOrReleaseSet  
      private org.apache.maven.toolchain.ToolchainManager toolchainManager  
      private boolean useIncrementalCompilation
      to enable/disable incremental compilation feature.
      private boolean verbose
      Set to true to show messages about what the compiler is doing.

      • Fields inherited from interface org.apache.maven.plugin.Mojo

        ROLE

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      private java.util.Set<java.io.File> computeStaleSources​(org.codehaus.plexus.compiler.CompilerConfiguration compilerConfiguration, org.codehaus.plexus.compiler.Compiler compiler, org.codehaus.plexus.compiler.util.scan.SourceInclusionScanner scanner)  
      private java.util.Set<org.eclipse.aether.graph.Exclusion> convertToAetherExclusions​(java.util.Set<DependencyExclusion> exclusions)  
      private java.util.List<org.eclipse.aether.graph.Dependency> convertToDependencies​(java.util.List<DependencyCoordinate> annotationProcessorPaths)  
      private void createMissingPackageInfoClasses​(org.codehaus.plexus.compiler.CompilerConfiguration compilerConfiguration, org.codehaus.plexus.compiler.util.scan.mapping.SourceMapping sourceMapping, java.util.Set<java.io.File> sources)  
      void execute()  
      private java.util.Optional<java.lang.String> findManagedVersion​(DependencyCoordinate dependencyCoordinate, java.util.List<org.apache.maven.model.Dependency> managedDependencies)  
      private byte[] generatePackage​(org.codehaus.plexus.compiler.CompilerConfiguration compilerConfiguration, java.lang.String javaFile)  
      private java.lang.String getAnnotationProcessorPathVersion​(DependencyCoordinate annotationProcessorPath)  
      protected java.util.Date getBuildStartTime()  
      private java.util.Optional<java.time.Instant> getBuildStartTimeInstant()  
      protected abstract java.util.List<java.lang.String> getClasspathElements()  
      protected abstract java.lang.String getCompilerArgument()  
      protected abstract java.util.Map<java.lang.String,​java.lang.String> getCompilerArguments()  
      protected abstract java.util.List<java.lang.String> getCompileSourceRoots()  
      private java.util.Set<java.io.File> getCompileSources​(org.codehaus.plexus.compiler.Compiler compiler, org.codehaus.plexus.compiler.CompilerConfiguration compilerConfiguration)  
      protected abstract java.lang.String getDebugFileName()  
      protected abstract java.util.Set<java.lang.String> getExcludes()  
      protected abstract java.io.File getGeneratedSourcesDirectory()  
      (package private) java.lang.String getImplicit()  
      protected abstract java.util.Set<java.lang.String> getIncludes()  
      private java.util.List<org.eclipse.aether.graph.Dependency> getManagedDependenciesForAnnotationProcessorPaths()  
      private java.lang.String getMavenCompilerPluginVersion()  
      private java.lang.String getMemoryValue​(java.lang.String setting)  
      protected java.util.Optional<java.nio.file.Path> getModuleDeclaration​(java.util.Set<java.io.File> sourceFiles)  
      protected abstract java.util.List<java.lang.String> getModulepathElements()  
      private int getOpcode​(org.codehaus.plexus.compiler.CompilerConfiguration compilerConfiguration)  
      protected abstract java.io.File getOutputDirectory()  
      protected abstract java.util.Map<java.lang.String,​org.codehaus.plexus.languages.java.jpms.JavaModuleDescriptor> getPathElements()  
      protected org.apache.maven.project.MavenProject getProject()  
      private java.util.List<org.apache.maven.model.Dependency> getProjectManagedDependencies()  
      protected abstract java.lang.String getRelease()  
      protected int getRequestThreadCount()
      try to get thread count if a Maven 3 build, using reflection as the plugin must not be maven3 api dependent
      protected abstract java.lang.String getSource()  
      protected abstract org.codehaus.plexus.compiler.util.scan.SourceInclusionScanner getSourceInclusionScanner​(int staleMillis)  
      protected abstract org.codehaus.plexus.compiler.util.scan.SourceInclusionScanner getSourceInclusionScanner​(java.lang.String inputFileEnding)  
      private org.codehaus.plexus.compiler.util.scan.mapping.SourceMapping getSourceMapping​(org.codehaus.plexus.compiler.CompilerConfiguration compilerConfiguration, org.codehaus.plexus.compiler.Compiler compiler)  
      protected abstract java.lang.String getTarget()  
      protected org.apache.maven.toolchain.Toolchain getToolchain()  
      private boolean hasInputFileTreeChanged​(org.apache.maven.shared.incremental.IncrementalBuildHelper ibh, java.util.Set<java.io.File> inputFiles)  
      private boolean hasNewFile​(java.nio.file.Path file, java.time.Instant buildStartTime)  
      protected boolean isDependencyChanged()
      We just compare the timestamps of all local dependency files (inter-module dependency classpath) and the own generated classes and if we got a file which is >= the build-started timestamp, then we caught a file which got changed during this build.
      private boolean isDigits​(java.lang.String string)  
      private boolean isSourceChanged​(org.codehaus.plexus.compiler.CompilerConfiguration compilerConfiguration, org.codehaus.plexus.compiler.Compiler compiler)  
      protected boolean isTestCompile()  
      private void patchJdkModuleVersion​(org.codehaus.plexus.compiler.CompilerResult compilerResult, java.util.Set<java.io.File> sources)
      JDK-8318913 workaround: Patch module-info.class to set the java release version for java/jdk modules.
      protected abstract void preparePaths​(java.util.Set<java.io.File> sourceFiles)  
      private static java.util.List<java.lang.String> removeEmptyCompileSourceRoots​(java.util.List<java.lang.String> compileSourceRootsList)  
      private java.util.List<java.lang.String> resolveProcessorPathEntries()  
      void setRelease​(java.lang.String release)  
      void setTarget​(java.lang.String target)  
      private void writeConfig​(org.apache.maven.shared.utils.logging.MessageBuilder mb)  
      private void writePlugin​(org.apache.maven.shared.utils.logging.MessageBuilder mb)  

      • Methods inherited from class org.apache.maven.plugin.AbstractMojo

        getLog, getPluginContext, setLog, setPluginContext

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • PS

        protected static final java.lang.String PS

      • INPUT_FILES_LST_FILENAME

        private static final java.lang.String INPUT_FILES_LST_FILENAME
        See Also:
        Constant Field Values

      • failOnError

        @Parameter(property="maven.compiler.failOnError",
           defaultValue="true")
private boolean failOnError
        Indicates whether the build will continue even if there are compilation errors.
        Since:
        2.0.2

      • failOnWarning

        @Parameter(property="maven.compiler.failOnWarning",
           defaultValue="false")
private boolean failOnWarning
        Indicates whether the build will continue even if there are compilation warnings.
        Since:
        3.6

      • debug

        @Parameter(property="maven.compiler.debug",
           defaultValue="true")
private boolean debug
        Set to true to include debugging information in the compiled class files.
        See Also:
        javac -g, debuglevel

      • parameters

        @Parameter(property="maven.compiler.parameters",
           defaultValue="false")
private boolean parameters
        Set to true to generate metadata for reflection on method parameters.
        Since:
        3.6.2
        See Also:
        javac -parameters

      • enablePreview

        @Parameter(property="maven.compiler.enablePreview",
           defaultValue="false")
private boolean enablePreview
        Set to true to enable preview language features of the java compiler
        Since:
        3.10.1
        See Also:
        javac --enable-preview

      • verbose

        @Parameter(property="maven.compiler.verbose",
           defaultValue="false")
private boolean verbose
        Set to true to show messages about what the compiler is doing.
        See Also:
        javac -verbose

      • showDeprecation

        @Parameter(property="maven.compiler.showDeprecation",
           defaultValue="false")
private boolean showDeprecation
        Sets whether to show source locations where deprecated APIs are used.

      • optimize

        @Deprecated
@Parameter(property="maven.compiler.optimize",
           defaultValue="false")
private boolean optimize
        Deprecated.
        This property is a no-op in javac.
        Set to true to optimize the compiled code using the compiler's optimization methods.

      • showWarnings

        @Parameter(property="maven.compiler.showWarnings",
           defaultValue="true")
private boolean showWarnings
        Set to false to disable warnings during compilation.

      • source

        @Parameter(property="maven.compiler.source",
           defaultValue="1.8")
protected java.lang.String 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

        See Also:
        javac -source

      • target

        @Parameter(property="maven.compiler.target",
           defaultValue="1.8")
protected java.lang.String 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

        See Also:
        javac -target

      • release

        @Parameter(property="maven.compiler.release")
protected java.lang.String release
        The -release argument for the Java compiler, supported since Java9
        Since:
        3.6
        See Also:
        javac -release

      • encoding

        @Parameter(property="encoding",
           defaultValue="${project.build.sourceEncoding}")
private java.lang.String encoding
        The -encoding argument for the Java compiler.
        Since:
        2.1
        See Also:
        javac -encoding

      • staleMillis

        @Parameter(property="lastModGranularityMs",
           defaultValue="0")
private int staleMillis
        Sets the granularity in milliseconds of the last modification date for testing whether a source needs recompilation.

      • compilerId

        @Parameter(property="maven.compiler.compilerId",
           defaultValue="javac")
private java.lang.String compilerId
        The compiler id of the compiler to use. See this guide for more information.

      • compilerVersion

        @Deprecated
@Parameter(property="maven.compiler.compilerVersion")
private java.lang.String compilerVersion
        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.

      • fork

        @Parameter(property="maven.compiler.fork",
           defaultValue="false")
private boolean fork
        Allows running the compiler in a separate process. If false it uses the built in compiler, while if true it will use an executable.

      • meminitial

        @Parameter(property="maven.compiler.meminitial")
private java.lang.String meminitial
        Initial size, in megabytes, of the memory allocation pool, ex. "64", "64m" if fork is set to true.
        Since:
        2.0.1

      • maxmem

        @Parameter(property="maven.compiler.maxmem")
private java.lang.String maxmem
        Sets the maximum size, in megabytes, of the memory allocation pool, ex. "128", "128m" if fork is set to true.
        Since:
        2.0.1

      • executable

        @Parameter(property="maven.compiler.executable")
private java.lang.String executable
        Sets the executable of the compiler to use when fork is true.

      • proc

        @Parameter(property="maven.compiler.proc")
private java.lang.String 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.
        • full - annotation processing and compilation.
        full is the default. Starting with JDK 21, this option must be set explicitly.
        Since:
        2.2
        See Also:
        javac -proc, javac Annotation Processing

      • annotationProcessors

        @Parameter
private java.lang.String[] annotationProcessors

        Names of annotation processors to run. Only applies to JDK 1.6+ If not set, the default annotation processors discovery process applies.

        Since:
        2.2
        See Also:
        javac -processor, javac Annotation Processing

      • annotationProcessorPaths

        @Parameter
private java.util.List<DependencyCoordinate> 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> <!-- Optional - taken from dependency management if not specified -->
       <!-- Optionally exclude transitive dependencies -->
       <exclusions>
         <exclusion>
           <groupId>org.sample</groupId>
           <artifactId>sample-dependency</artifactId>
         </exclusion>
       </exclusions>
     </path>
     <!-- ... more ... -->
   </annotationProcessorPaths>
 </configuration>
        Note: Exclusions are supported from version 3.11.0.
        Since:
        3.5
        See Also:
        javac -processorpath, javac Annotation Processing

      • annotationProcessorPathsUseDepMgmt

        @Parameter(defaultValue="false")
private boolean annotationProcessorPathsUseDepMgmt

        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.

        Since:
        3.12.0

      • compilerArguments

        @Parameter
@Deprecated
protected java.util.Map<java.lang.String,​java.lang.String> compilerArguments
        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: 

         <compilerArguments>
   <Xmaxerrs>1000</Xmaxerrs>
   <Xlint/>
   <Xlint:-path/>
   <Averbose>true</Averbose>
 </compilerArguments>
        Since:
        2.0.1

      • compilerArgs

        @Parameter
protected java.util.List<java.lang.String> compilerArgs

        Sets the arguments to be passed to the compiler.

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

        Example: 
         <compilerArgs>
   <arg>-Xmaxerrs</arg>
   <arg>1000</arg>
   <arg>-Xlint</arg>
   <arg>-J-Duser.language=en_us</arg>
 </compilerArgs>
        Since:
        3.1
        See Also:
        javac -J

      • compilerArgument

        @Parameter
protected java.lang.String 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 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

      • outputFileName

        @Parameter
private java.lang.String outputFileName
        Sets the name of the output file when compiling a set of sources to a single file.

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

      • debuglevel

        @Parameter(property="maven.compiler.debuglevel")
private java.lang.String debuglevel
        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.
        Since:
        2.1
        See Also:
        javac -G:[lines,vars,source]

      • implicit

        @Parameter(property="maven.compiler.implicit")
private java.lang.String implicit
        Keyword to be appended to the -implicit: command-line switch.
        Since:
        3.10.2
        See Also:
        javac -implicit

      • toolchainManager

        @Component
private org.apache.maven.toolchain.ToolchainManager toolchainManager

      • jdkToolchain

        @Parameter
private java.util.Map<java.lang.String,​java.lang.String> 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.

        (see Guide to Toolchains for more info) 
         <configuration>
   <jdkToolchain>
     <version>11</version>
   </jdkToolchain>
   ...
 </configuration>

 <configuration>
   <jdkToolchain>
     <version>1.8</version>
     <vendor>zulu</vendor>
   </jdkToolchain>
   ...
 </configuration>
        note: requires at least Maven 3.3.1
        Since:
        3.6

      • basedir

        @Parameter(defaultValue="${basedir}",
           required=true,
           readonly=true)
private java.io.File basedir
        The directory to run the compiler from if fork is true.

      • buildDirectory

        @Parameter(defaultValue="${project.build.directory}",
           required=true,
           readonly=true)
private java.io.File buildDirectory
        The target directory of the compiler if fork is true.

      • compilerManager

        @Component
private org.codehaus.plexus.compiler.manager.CompilerManager compilerManager
        Plexus compiler manager.

      • session

        @Parameter(defaultValue="${session}",
           readonly=true,
           required=true)
private org.apache.maven.execution.MavenSession session
        The current build session instance. This is used for toolchain manager API calls.

      • project

        @Parameter(defaultValue="${project}",
           readonly=true,
           required=true)
private org.apache.maven.project.MavenProject project
        The current project instance. This is used for propagating generated-sources paths as compile/testCompile source roots.

      • compilerReuseStrategy

        @Parameter(defaultValue="${reuseCreated}",
           property="maven.compiler.compilerReuseStrategy")
private java.lang.String compilerReuseStrategy
        Strategy to re use javacc class created:
        • reuseCreated (default): will reuse already created but in case of multi-threaded builds, each thread will have its own instance
        • reuseSame: the same Javacc class will be used for each compilation even for multi-threaded build
        • alwaysNew: a new Javacc class will be created for each compilation
        Note this parameter value depends on the os/jdk you are using, but the default value should work on most of env.
        Since:
        2.5

      • skipMultiThreadWarning

        @Parameter(defaultValue="false",
           property="maven.compiler.skipMultiThreadWarning")
private boolean skipMultiThreadWarning
        Since:
        2.5

      • forceJavacCompilerUse

        @Deprecated
@Parameter(defaultValue="false",
           property="maven.compiler.forceJavacCompilerUse")
private boolean forceJavacCompilerUse
        Deprecated.
        Use forceLegacyJavacApi instead
        Legacy parameter name of forceLegacyJavacApi. Only considered if forceLegacyJavacApi is not set or false.
        Since:
        3.0

      • forceLegacyJavacApi

        @Parameter(defaultValue="false",
           property="maven.compiler.forceLegacyJavacApi")
private boolean forceLegacyJavacApi
        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.

        Since:
        3.13

      • mojoExecution

        @Parameter(defaultValue="${mojoExecution}",
           readonly=true,
           required=true)
private org.apache.maven.plugin.MojoExecution mojoExecution
        Since:
        3.0 needed for storing the status for the incremental build support.

      • fileExtensions

        @Parameter(defaultValue="class,jar")
private java.util.Set<java.lang.String> fileExtensions
        File extensions to check timestamp for incremental build.
        Since:
        3.1

      • useIncrementalCompilation

        @Parameter(defaultValue="true",
           property="maven.compiler.useIncrementalCompilation")
private boolean 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.
        Since:
        3.1

      • createMissingPackageInfoClass

        @Parameter(defaultValue="true",
           property="maven.compiler.createMissingPackageInfoClass")
private boolean createMissingPackageInfoClass
        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.
        Since:
        3.10

      • showCompilationChanges

        @Parameter(defaultValue="false",
           property="maven.compiler.showCompilationChanges")
private boolean showCompilationChanges

      • outputTimestamp

        @Parameter(defaultValue="${project.build.outputTimestamp}")
private java.lang.String outputTimestamp
        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).
        Since:
        3.12.0

      • repositorySystem

        @Component
private org.eclipse.aether.RepositorySystem repositorySystem
        Resolves the artifacts needed.

      • artifactHandlerManager

        @Component
private org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager
        Artifact handler manager.

      • targetOrReleaseSet

        private boolean targetOrReleaseSet

    • Constructor Detail

      • AbstractCompilerMojo

        public AbstractCompilerMojo()

    • Method Detail

      • getSourceInclusionScanner

        protected abstract org.codehaus.plexus.compiler.util.scan.SourceInclusionScanner getSourceInclusionScanner​(int staleMillis)

      • getSourceInclusionScanner

        protected abstract org.codehaus.plexus.compiler.util.scan.SourceInclusionScanner getSourceInclusionScanner​(java.lang.String inputFileEnding)

      • getClasspathElements

        protected abstract java.util.List<java.lang.String> getClasspathElements()

      • getModulepathElements

        protected abstract java.util.List<java.lang.String> getModulepathElements()

      • getPathElements

        protected abstract java.util.Map<java.lang.String,​org.codehaus.plexus.languages.java.jpms.JavaModuleDescriptor> getPathElements()

      • getCompileSourceRoots

        protected abstract java.util.List<java.lang.String> getCompileSourceRoots()

      • preparePaths

        protected abstract void preparePaths​(java.util.Set<java.io.File> sourceFiles)

      • getOutputDirectory

        protected abstract java.io.File getOutputDirectory()

      • getSource

        protected abstract java.lang.String getSource()

      • getTarget

        protected abstract java.lang.String getTarget()

      • getRelease

        protected abstract java.lang.String getRelease()

      • getCompilerArgument

        protected abstract java.lang.String getCompilerArgument()

      • getCompilerArguments

        protected abstract java.util.Map<java.lang.String,​java.lang.String> getCompilerArguments()

      • getGeneratedSourcesDirectory

        protected abstract java.io.File getGeneratedSourcesDirectory()

      • getDebugFileName

        protected abstract java.lang.String getDebugFileName()

      • getProject

        protected final org.apache.maven.project.MavenProject getProject()

      • getModuleDeclaration

        protected final java.util.Optional<java.nio.file.Path> getModuleDeclaration​(java.util.Set<java.io.File> sourceFiles)

      • createMissingPackageInfoClasses

        private void createMissingPackageInfoClasses​(org.codehaus.plexus.compiler.CompilerConfiguration compilerConfiguration,
                                             org.codehaus.plexus.compiler.util.scan.mapping.SourceMapping sourceMapping,
                                             java.util.Set<java.io.File> sources)
                                      throws org.codehaus.plexus.compiler.util.scan.InclusionScanException,
                                             java.io.IOException
        Throws:
        org.codehaus.plexus.compiler.util.scan.InclusionScanException
        java.io.IOException

      • generatePackage

        private byte[] generatePackage​(org.codehaus.plexus.compiler.CompilerConfiguration compilerConfiguration,
                               java.lang.String javaFile)

      • getOpcode

        private int getOpcode​(org.codehaus.plexus.compiler.CompilerConfiguration compilerConfiguration)

      • isTestCompile

        protected boolean isTestCompile()

      • getCompileSources

        private java.util.Set<java.io.File> getCompileSources​(org.codehaus.plexus.compiler.Compiler compiler,
                                                      org.codehaus.plexus.compiler.CompilerConfiguration compilerConfiguration)
                                               throws org.apache.maven.plugin.MojoExecutionException,
                                                      org.codehaus.plexus.compiler.CompilerException
        Returns:
        all source files for the compiler
        Throws:
        org.apache.maven.plugin.MojoExecutionException
        org.codehaus.plexus.compiler.CompilerException

      • getIncludes

        protected abstract java.util.Set<java.lang.String> getIncludes()

      • getExcludes

        protected abstract java.util.Set<java.lang.String> getExcludes()

      • isSourceChanged

        private boolean isSourceChanged​(org.codehaus.plexus.compiler.CompilerConfiguration compilerConfiguration,
                                org.codehaus.plexus.compiler.Compiler compiler)
        Parameters:
        compilerConfiguration -
        compiler -
        Returns:
        true if at least a single source file is newer than it's class file

      • getRequestThreadCount

        protected int getRequestThreadCount()
        try to get thread count if a Maven 3 build, using reflection as the plugin must not be maven3 api dependent
        Returns:
        number of thread for this build or 1 if not multi-thread build

      • getBuildStartTime

        protected java.util.Date getBuildStartTime()

      • getBuildStartTimeInstant

        private java.util.Optional<java.time.Instant> getBuildStartTimeInstant()

      • getMemoryValue

        private java.lang.String getMemoryValue​(java.lang.String setting)

      • getToolchain

        protected final org.apache.maven.toolchain.Toolchain getToolchain()

      • isDigits

        private boolean isDigits​(java.lang.String string)

      • computeStaleSources

        private java.util.Set<java.io.File> computeStaleSources​(org.codehaus.plexus.compiler.CompilerConfiguration compilerConfiguration,
                                                        org.codehaus.plexus.compiler.Compiler compiler,
                                                        org.codehaus.plexus.compiler.util.scan.SourceInclusionScanner scanner)
                                                 throws org.apache.maven.plugin.MojoExecutionException,
                                                        org.codehaus.plexus.compiler.CompilerException
        Throws:
        org.apache.maven.plugin.MojoExecutionException
        org.codehaus.plexus.compiler.CompilerException

      • getSourceMapping

        private org.codehaus.plexus.compiler.util.scan.mapping.SourceMapping getSourceMapping​(org.codehaus.plexus.compiler.CompilerConfiguration compilerConfiguration,
                                                                                      org.codehaus.plexus.compiler.Compiler compiler)
                                                                               throws org.codehaus.plexus.compiler.CompilerException,
                                                                                      org.apache.maven.plugin.MojoExecutionException
        Throws:
        org.codehaus.plexus.compiler.CompilerException
        org.apache.maven.plugin.MojoExecutionException

      • removeEmptyCompileSourceRoots

        private static java.util.List<java.lang.String> removeEmptyCompileSourceRoots​(java.util.List<java.lang.String> compileSourceRootsList)

      • isDependencyChanged

        protected boolean isDependencyChanged()
        We just compare the timestamps of all local dependency files (inter-module dependency classpath) and the own generated classes and if we got a file which is >= the build-started timestamp, then we caught a file which got changed during this build.
        Returns:
        true if at least one single dependency has changed.

      • hasNewFile

        private boolean hasNewFile​(java.nio.file.Path file,
                           java.time.Instant buildStartTime)
        Parameters:
        file - entry to check
        buildStartTime - time build start
        Returns:
        if any changes occurred

      • resolveProcessorPathEntries

        private java.util.List<java.lang.String> resolveProcessorPathEntries()
                                                              throws org.apache.maven.plugin.MojoExecutionException
        Throws:
        org.apache.maven.plugin.MojoExecutionException

      • convertToDependencies

        private java.util.List<org.eclipse.aether.graph.Dependency> convertToDependencies​(java.util.List<DependencyCoordinate> annotationProcessorPaths)
                                                                           throws org.apache.maven.plugin.MojoExecutionException
        Throws:
        org.apache.maven.plugin.MojoExecutionException

      • getAnnotationProcessorPathVersion

        private java.lang.String getAnnotationProcessorPathVersion​(DependencyCoordinate annotationProcessorPath)
                                                    throws org.apache.maven.plugin.MojoExecutionException
        Throws:
        org.apache.maven.plugin.MojoExecutionException

      • findManagedVersion

        private java.util.Optional<java.lang.String> findManagedVersion​(DependencyCoordinate dependencyCoordinate,
                                                                java.util.List<org.apache.maven.model.Dependency> managedDependencies)

      • getManagedDependenciesForAnnotationProcessorPaths

        private java.util.List<org.eclipse.aether.graph.Dependency> getManagedDependenciesForAnnotationProcessorPaths()

      • getProjectManagedDependencies

        private java.util.List<org.apache.maven.model.Dependency> getProjectManagedDependencies()

      • convertToAetherExclusions

        private java.util.Set<org.eclipse.aether.graph.Exclusion> convertToAetherExclusions​(java.util.Set<DependencyExclusion> exclusions)

      • writePlugin

        private void writePlugin​(org.apache.maven.shared.utils.logging.MessageBuilder mb)

      • writeConfig

        private void writeConfig​(org.apache.maven.shared.utils.logging.MessageBuilder mb)

      • getMavenCompilerPluginVersion

        private java.lang.String getMavenCompilerPluginVersion()

      • hasInputFileTreeChanged

        private boolean hasInputFileTreeChanged​(org.apache.maven.shared.incremental.IncrementalBuildHelper ibh,
                                        java.util.Set<java.io.File> inputFiles)

      • setTarget

        public void setTarget​(java.lang.String target)

      • setRelease

        public void setRelease​(java.lang.String release)

      • getImplicit

        final java.lang.String getImplicit()

      • patchJdkModuleVersion

        private void patchJdkModuleVersion​(org.codehaus.plexus.compiler.CompilerResult compilerResult,
                                   java.util.Set<java.io.File> sources)
                            throws org.apache.maven.plugin.MojoExecutionException
        JDK-8318913 workaround: Patch module-info.class to set the java release version for java/jdk modules.
        Parameters:
        compilerResult - should succeed.
        sources - the list of the source files to check for the "module-info.java"
        Throws:
        org.apache.maven.plugin.MojoExecutionException
        See Also:
        MCOMPILER-542, JDK-8318913