Package org.apache.maven.plugin.plugin

Class PluginReport

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport
    @Mojo(name="report",
      threadSafe=true)
@Execute(phase=PROCESS_CLASSES)
public class PluginReport
extends org.apache.maven.reporting.AbstractMavenReport
    Generates the Plugin's documentation report: plugin-info.html plugin overview page, and one goal-mojo.html per goal.
    Since:
    2.0
    Author:
    Stephane Nicoll, Vincent Siveton

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected Set<org.apache.maven.artifact.Artifact> dependencies
      The set of dependencies for the current project
      protected String goalPrefix
      The goal prefix that will appear before the ":".
      protected org.apache.maven.artifact.repository.ArtifactRepository local
      Location of the local repository.
      protected org.apache.maven.tools.plugin.scanner.MojoScanner mojoScanner
      Mojo scanner tools.
      protected List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepos
      List of Remote Repositories used by the resolver

      • Fields inherited from interface org.apache.maven.reporting.MavenReport

        CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

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

        ROLE

    • Constructor Summary

      Constructors 
      Constructor Description
      PluginReport()  

    • Field Detail

      • mojoScanner

        @Component
protected org.apache.maven.tools.plugin.scanner.MojoScanner mojoScanner
        Mojo scanner tools.

      • goalPrefix

        @Parameter(property="goalPrefix")
protected String goalPrefix

        The goal prefix that will appear before the ":". By default, this plugin applies a heuristic to derive a heuristic from the plugin's artifactId.

        It removes any occurrences of the regular expression -?maven-?, and then removes any occurrences of -?plugin-?.

        For example, horsefeature-maven-plugin becomes horsefeature.

        (There is a special case for maven-plugin-plugin: it is mapped to 'plugin')

        Since:
        2.4

      • dependencies

        @Parameter(defaultValue="${project.artifacts}",
           required=true,
           readonly=true)
protected Set<org.apache.maven.artifact.Artifact> dependencies
        The set of dependencies for the current project
        Since:
        3.0

      • remoteRepos

        @Parameter(defaultValue="${project.remoteArtifactRepositories}",
           required=true,
           readonly=true)
protected List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepos
        List of Remote Repositories used by the resolver
        Since:
        3.0

      • local

        @Parameter(defaultValue="${localRepository}",
           required=true,
           readonly=true)
protected org.apache.maven.artifact.repository.ArtifactRepository local
        Location of the local repository.
        Since:
        3.0

    • Constructor Detail

      • PluginReport

        public PluginReport()

    • Method Detail

      • getSiteRenderer

        protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
        Overrides:
        getSiteRenderer in class org.apache.maven.reporting.AbstractMavenReport

      • getOutputDirectory

        protected String getOutputDirectory()
        Overrides:
        getOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport

      • getProject

        protected org.apache.maven.project.MavenProject getProject()
        Overrides:
        getProject in class org.apache.maven.reporting.AbstractMavenReport

      • canGenerateReport

        public boolean canGenerateReport()
        Specified by:
        canGenerateReport in interface org.apache.maven.reporting.MavenReport
        Overrides:
        canGenerateReport in class org.apache.maven.reporting.AbstractMavenReport

      • executeReport

        protected void executeReport​(Locale locale)
                      throws org.apache.maven.reporting.MavenReportException
        Specified by:
        executeReport in class org.apache.maven.reporting.AbstractMavenReport
        Throws:
        org.apache.maven.reporting.MavenReportException

      • getDescription

        public String getDescription​(Locale locale)

      • getOutputName

        public String getOutputName()

      • getBundle

        protected static ResourceBundle getBundle​(Locale locale)
        Parameters:
        locale - not null
        Returns:
        the bundle for this report