|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.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 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 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 | |
---|---|
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 org.apache.maven.project.MavenProject |
getProject()
|
protected org.apache.maven.doxia.siterenderer.Renderer |
getSiteRenderer()
|
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport |
---|
closeReport, execute, generate, generate, generate, getCategoryName, getReportOutputDirectory, getSink, getSinkFactory, 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 horsefeature.
(There is a special for maven-plugin-plugin; it is mapped to 'plugin'.
protected Set<org.apache.maven.artifact.Artifact> dependencies
protected List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepos
protected org.apache.maven.artifact.repository.ArtifactRepository local
Constructor Detail |
---|
public PluginReport()
Method Detail |
---|
protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
getSiteRenderer
in class org.apache.maven.reporting.AbstractMavenReport
protected String getOutputDirectory()
getOutputDirectory
in class org.apache.maven.reporting.AbstractMavenReport
protected org.apache.maven.project.MavenProject getProject()
getProject
in class org.apache.maven.reporting.AbstractMavenReport
public boolean canGenerateReport()
canGenerateReport
in interface org.apache.maven.reporting.MavenReport
canGenerateReport
in class org.apache.maven.reporting.AbstractMavenReport
protected void executeReport(Locale locale) throws org.apache.maven.reporting.MavenReportException
executeReport
in class org.apache.maven.reporting.AbstractMavenReport
org.apache.maven.reporting.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 |