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 Configurator confugurator  
      private java.lang.String docencoding  
      private java.lang.String encoding  
      private org.codehaus.plexus.logging.Logger logger  
      private java.util.List<org.apache.maven.project.MavenProject> reactorProjects  
      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
      void execute()  
      private static java.util.Set<java.nio.file.Path> findFiles​(java.util.Collection<java.nio.file.Path> dirs, java.lang.String regex)  
      private java.nio.file.Path getOutputDir()  
      private void populateClasspath​(java.util.Collection<java.nio.file.Path> reactorClassPath, java.util.Collection<java.nio.file.Path> fullClassPath)  
      private static java.lang.String quoted​(java.lang.Object obj)  
      • 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

        @Component
        private org.codehaus.plexus.logging.Logger logger
      • resolver

        @Component
        private org.apache.maven.project.ProjectDependenciesResolver resolver
      • confugurator

        @Component
        private Configurator confugurator
      • toolchainManager

        @Component
        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")
        private java.lang.String source
    • Constructor Detail

      • JavadocMojo

        public JavadocMojo()
    • Method Detail

      • quoted

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

        private static java.util.Set<java.nio.file.Path> findFiles​(java.util.Collection<java.nio.file.Path> dirs,
                                                                   java.lang.String regex)
                                                            throws java.io.IOException
        Throws:
        java.io.IOException
      • getOutputDir

        private java.nio.file.Path getOutputDir()
      • populateClasspath

        private void populateClasspath​(java.util.Collection<java.nio.file.Path> reactorClassPath,
                                       java.util.Collection<java.nio.file.Path> fullClassPath)
      • 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