Package org.fedoraproject.xmvn.mojo

Class JavadocMojo

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
    @Mojo(name="javadoc",
      aggregator=true,
      requiresDependencyResolution=COMPILE)
public class JavadocMojo
extends org.apache.maven.plugin.AbstractMojo

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.io.File buildDirectory  
      private java.lang.String docencoding  
      private java.lang.String encoding  
      private boolean ignoreJPMS  
      private Logger logger  
      private ModuleGleaner moduleGleaner  
      private java.util.List<java.lang.String> options  
      private java.util.List<org.apache.maven.project.MavenProject> reactorProjects  
      private java.lang.String release  
      private org.apache.maven.project.ProjectDependenciesResolver resolver  
      private org.apache.maven.execution.MavenSession session  
      private java.lang.String source  
      private org.apache.maven.toolchain.ToolchainManager toolchainManager  

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

        ROLE

    • Constructor Summary

      Constructors 
      Constructor Description
      JavadocMojo()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      private void addOpt​(java.lang.String name)  
      private boolean addOpt​(java.lang.String name, java.lang.String value)  
      private void addOpt​(java.lang.String name, java.lang.String value, java.lang.String deflt)  
      private boolean addOpt​(java.lang.String name, java.nio.file.Path path)  
      private void addOptPath​(java.lang.String name, java.util.stream.Stream<java.nio.file.Path> stream)  
      private boolean addOptPrefix​(java.lang.String name, java.lang.String prefix, java.lang.String value)  
      private void addOptPrefixPath​(java.lang.String name, java.lang.String prefix, java.util.stream.Stream<java.nio.file.Path> stream)  
      private void discoverModule​(java.util.List<JavadocModule> modules, java.util.List<java.lang.String> reactorArtifacts, org.apache.maven.project.MavenProject project)  
      private java.util.List<JavadocModule> discoverModules()  
      void execute()  
      private java.util.Set<java.nio.file.Path> findJavaSources​(java.util.List<JavadocModule> modules)  
      private java.nio.file.Path getOutputDir()  
      private void invokeJavadoc​(java.nio.file.Path outputDir)  
      private static java.lang.String quoted​(java.lang.Object obj)  
      private java.nio.file.Path selectJavadocExecutable()  
      private void skipJPMSOnSourceBelow9()  

      • 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

      • logger

        @Inject
private Logger logger

      • resolver

        @Inject
private org.apache.maven.project.ProjectDependenciesResolver resolver

      • toolchainManager

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

      • session

        @Parameter(defaultValue="${session}",
           readonly=true)
private org.apache.maven.execution.MavenSession session

      • reactorProjects

        @Parameter(defaultValue="${reactorProjects}",
           readonly=true,
           required=true)
private java.util.List<org.apache.maven.project.MavenProject> reactorProjects

      • encoding

        @Parameter(defaultValue="${project.build.sourceEncoding}")
private java.lang.String encoding

      • docencoding

        @Parameter(defaultValue="${project.reporting.outputEncoding}")
private java.lang.String docencoding

      • buildDirectory

        @Parameter(defaultValue="${project.build.directory}",
           required=true)
private java.io.File buildDirectory

      • source

        @Parameter(property="source",
           defaultValue="${maven.compiler.source}")
private java.lang.String source

      • release

        @Parameter(defaultValue="${maven.compiler.release}")
private java.lang.String release

      • ignoreJPMS

        @Parameter(property="xmvn.javadoc.ignoreJPMS")
private boolean ignoreJPMS

      • options

        private java.util.List<java.lang.String> options

    • Constructor Detail

      • JavadocMojo

        public JavadocMojo()

    • Method Detail

      • quoted

        private static java.lang.String quoted​(java.lang.Object obj)

      • getOutputDir

        private java.nio.file.Path getOutputDir()

      • findJavaSources

        private java.util.Set<java.nio.file.Path> findJavaSources​(java.util.List<JavadocModule> modules)
                                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • discoverModule

        private void discoverModule​(java.util.List<JavadocModule> modules,
                            java.util.List<java.lang.String> reactorArtifacts,
                            org.apache.maven.project.MavenProject project)

      • discoverModules

        private java.util.List<JavadocModule> discoverModules()

      • addOpt

        private void addOpt​(java.lang.String name)

      • addOpt

        private boolean addOpt​(java.lang.String name,
                       java.lang.String value)

      • addOpt

        private boolean addOpt​(java.lang.String name,
                       java.nio.file.Path path)

      • addOpt

        private void addOpt​(java.lang.String name,
                    java.lang.String value,
                    java.lang.String deflt)

      • addOptPrefix

        private boolean addOptPrefix​(java.lang.String name,
                             java.lang.String prefix,
                             java.lang.String value)

      • addOptPath

        private void addOptPath​(java.lang.String name,
                        java.util.stream.Stream<java.nio.file.Path> stream)

      • addOptPrefixPath

        private void addOptPrefixPath​(java.lang.String name,
                              java.lang.String prefix,
                              java.util.stream.Stream<java.nio.file.Path> stream)

      • selectJavadocExecutable

        private java.nio.file.Path selectJavadocExecutable()

      • skipJPMSOnSourceBelow9

        private void skipJPMSOnSourceBelow9()

      • invokeJavadoc

        private void invokeJavadoc​(java.nio.file.Path outputDir)
                    throws java.io.IOException,
                           java.lang.InterruptedException,
                           org.apache.maven.plugin.MojoFailureException
        Throws:
        java.io.IOException
        java.lang.InterruptedException
        org.apache.maven.plugin.MojoFailureException

      • execute

        public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException
        Throws:
        org.apache.maven.plugin.MojoExecutionException
        org.apache.maven.plugin.MojoFailureException