|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.apache.maven.plugin.plugin.PluginReport
public class PluginReport
Generates the Plugin's documentation report.
Field Summary | |
---|---|
protected String |
goalPrefix
The goal prefix that will appear before the ":". |
protected MojoScanner |
mojoScanner
Mojo scanner tools. |
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 | |
---|---|
PluginReport()
|
Method Summary | |
---|---|
boolean |
canGenerateReport()
|
protected void |
executeReport(Locale locale)
|
protected static ResourceBundle |
getBundle(Locale locale)
|
String |
getDescription(Locale locale)
|
String |
getName(Locale locale)
|
protected String |
getOutputDirectory()
|
String |
getOutputName()
|
protected MavenProject |
getProject()
|
protected Renderer |
getSiteRenderer()
|
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport |
---|
closeReport, execute, generate, getCategoryName, getReportOutputDirectory, getSink, 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 |
Field Detail |
---|
protected MojoScanner mojoScanner
protected String goalPrefix
For example, horsefeature-maven-plugin becomes horsefeather.
(There is a special for maven-plugin-plugin; it is mapped to 'plugin'.
Constructor Detail |
---|
public PluginReport()
Method Detail |
---|
protected Renderer getSiteRenderer()
getSiteRenderer
in class AbstractMavenReport
protected String getOutputDirectory()
getOutputDirectory
in class AbstractMavenReport
protected MavenProject getProject()
getProject
in class AbstractMavenReport
public boolean canGenerateReport()
canGenerateReport
in interface MavenReport
canGenerateReport
in class AbstractMavenReport
protected void executeReport(Locale locale) throws MavenReportException
executeReport
in class AbstractMavenReport
MavenReportException
public String getDescription(Locale locale)
public String getName(Locale locale)
public String getOutputName()
protected static ResourceBundle getBundle(Locale locale)
locale
- not null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |