Class PluginReport
java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.apache.maven.plugin.plugin.report_old.PluginReport
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled
,org.apache.maven.plugin.Mojo
,org.apache.maven.reporting.MavenMultiPageReport
,org.apache.maven.reporting.MavenReport
@Deprecated
@Mojo(name="report",
threadSafe=true)
@Execute(phase=PROCESS_CLASSES)
public class PluginReport
extends org.apache.maven.reporting.AbstractMavenReport
Deprecated.
use the maven-plugin-report-plugin instead
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 DescriptorGeneratorMojo
.- Since:
- 2.0
- Author:
- Stephane Nicoll, Vincent Siveton
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected String
Deprecated.not used in report, will be removed in the next major versionFields 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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Deprecated.protected void
executeReport
(Locale locale) Deprecated.protected static ResourceBundle
Deprecated.getDescription
(Locale locale) Deprecated.Deprecated.protected String
Deprecated.Deprecated.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
-
Field Details
-
goalPrefix
Deprecated.not used in report, will be removed in the next major versionThe 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
-
-
Constructor Details
-
PluginReport
public PluginReport()Deprecated.
-
-
Method Details
-
getOutputDirectory
Deprecated.- Overrides:
getOutputDirectory
in classorg.apache.maven.reporting.AbstractMavenReport
-
canGenerateReport
Deprecated.- Specified by:
canGenerateReport
in interfaceorg.apache.maven.reporting.MavenReport
- Overrides:
canGenerateReport
in classorg.apache.maven.reporting.AbstractMavenReport
-
executeReport
Deprecated.- Specified by:
executeReport
in classorg.apache.maven.reporting.AbstractMavenReport
- Throws:
org.apache.maven.reporting.MavenReportException
-
getDescription
Deprecated. -
getName
Deprecated. -
getOutputName
Deprecated. -
getBundle
Deprecated.- Parameters:
locale
- not null- Returns:
- the bundle for this report
-