org.apache.maven.plugin.plugin
Class PluginReport

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.reporting.AbstractMavenReport
          extended by org.apache.maven.plugin.plugin.PluginReport
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport

public class PluginReport
extends org.apache.maven.reporting.AbstractMavenReport

Generates the Plugin's documentation report.

Since:
2.0
Version:
$Id: PluginReport.java 684481 2008-08-10 12:13:27Z bentmann $
Author:
Stephane Nicoll, Vincent Siveton

Field Summary
protected  java.lang.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(java.util.Locale locale)
          
protected static java.util.ResourceBundle getBundle(java.util.Locale locale)
           
 java.lang.String getDescription(java.util.Locale locale)
          
 java.lang.String getName(java.util.Locale locale)
          
protected  java.lang.String getOutputDirectory()
          
 java.lang.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

mojoScanner

protected MojoScanner mojoScanner
Mojo scanner tools.


goalPrefix

protected java.lang.String goalPrefix
The goal prefix that will appear before the ":".

Since:
2.4
Constructor Detail

PluginReport

public PluginReport()
Method Detail

getSiteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()

Specified by:
getSiteRenderer in class org.apache.maven.reporting.AbstractMavenReport

getOutputDirectory

protected java.lang.String getOutputDirectory()

Specified by:
getOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport

getProject

protected org.apache.maven.project.MavenProject getProject()

Specified by:
getProject in class org.apache.maven.reporting.AbstractMavenReport

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(java.util.Locale locale)
                      throws org.apache.maven.reporting.MavenReportException

Specified by:
executeReport in class org.apache.maven.reporting.AbstractMavenReport
Throws:
org.apache.maven.reporting.MavenReportException

getDescription

public java.lang.String getDescription(java.util.Locale locale)


getName

public java.lang.String getName(java.util.Locale locale)


getOutputName

public java.lang.String getOutputName()


getBundle

protected static java.util.ResourceBundle getBundle(java.util.Locale locale)
Parameters:
locale - not null
Returns:
the bundle for this report


Copyright © 2004-2010 Apache Software Foundation. All Rights Reserved.