PluginReport (Maven Plugin Tools 3.12.0 API)

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.apache.maven.reporting.AbstractMavenReport
  - - org.apache.maven.plugin.plugin.report.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. Relies on one output file from plugin:descriptor.

Since:

3.7.0

Author:

Stephane Nicoll, Vincent Siveton

Field Summary
- Fields inherited from class org.apache.maven.reporting.AbstractMavenReport
  localRepository, outputDirectory, project, remoteRepositories, siteRenderer, siteTool
- 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()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`canGenerateReport()`
`protected void`	`executeReport(Locale locale)`
`String`	`getDescription(Locale locale)`
`String`	`getName(Locale locale)`
`String`	`getOutputName()`

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
closeReport, execute, generate, generate, generate, getCategoryName, getInputEncoding, getOutputDirectory, getOutputEncoding, getProject, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, isExternalReport, setReportOutputDirectory

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

- Constructor Detail
  - PluginReport
```
public PluginReport()
```
- Method Detail
  - 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
  - getName
```
public String getName(Locale locale)
```
  - getDescription
```
public String getDescription(Locale locale)
```
  - getOutputName
```
public String getOutputName()
```