org.apache.tapestry.mojo
Class ComponentReport

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          org.apache.tapestry.mojo.ComponentReport

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport

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

The component report generates documentation about components and parameters within the current project.

Field Summary

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

ComponentReport()

Method Summary

protected List<File>	createDocSearchPath()
protected void	executeReport(Locale locale) Generates the report; this consist of the index page
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()
Map<String,ClassDescription>	readXML(String path)
protected Map<String,ClassDescription>	runJavadoc()

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

canGenerateReport, 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

Constructor Detail

ComponentReport

public ComponentReport()

Method Detail

getOutputDirectory

protected 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

getSiteRenderer

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

Specified by:

getSiteRenderer in class org.apache.maven.reporting.AbstractMavenReport

getDescription

public String getDescription(Locale locale)

getName

public String getName(Locale locale)

getOutputName

public String getOutputName()

executeReport

protected void executeReport(Locale locale)
                      throws org.apache.maven.reporting.MavenReportException

Generates the report; this consist of the index page

Specified by:

executeReport in class org.apache.maven.reporting.AbstractMavenReport

Parameters:

locale -

Throws:

org.apache.maven.reporting.MavenReportException

createDocSearchPath

protected List<File> createDocSearchPath()

runJavadoc

protected Map<String,ClassDescription> runJavadoc()
                                           throws org.apache.maven.reporting.MavenReportException

Throws:

org.apache.maven.reporting.MavenReportException

readXML

public Map<String,ClassDescription> readXML(String path)
                                     throws org.apache.maven.reporting.MavenReportException

Throws:

org.apache.maven.reporting.MavenReportException