Class PluginReport
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, 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
-
Method Summary
Modifier and TypeMethodDescriptionboolean
protected void
executeReport
(Locale locale) protected static ResourceBundle
getDescription
(Locale locale) protected String
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
closeReport, execute, generate, generate, generate, getCategoryName, getInputEncoding, getOutputEncoding, getProject, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, isExternalReport, setReportOutputDirectory
Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext
-
Constructor Details
-
PluginReport
public PluginReport()
-
-
Method Details
-
getOutputDirectory
- Overrides:
getOutputDirectory
in classorg.apache.maven.reporting.AbstractMavenReport
-
canGenerateReport
- Specified by:
canGenerateReport
in interfaceorg.apache.maven.reporting.MavenReport
- Overrides:
canGenerateReport
in classorg.apache.maven.reporting.AbstractMavenReport
-
executeReport
- Specified by:
executeReport
in classorg.apache.maven.reporting.AbstractMavenReport
- Throws:
org.apache.maven.reporting.MavenReportException
-
getDescription
-
getName
-
getOutputName
-
getBundle
- Parameters:
locale
- not null- Returns:
- the bundle for this report
-