org.apache.myfaces.buildtools.maven2.plugin.tagdoc
Class TagdocIndexReport

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          org.apache.myfaces.buildtools.maven2.plugin.tagdoc.TagdocIndexReport

All Implemented Interfaces:

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

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

Report for generating JSF tagdoc index based on myfaces-metadata.xml parsing. The content is generated using velocity in xdoc files (see TagdocContentMojo).

Author:

Leonardo Uribe

Nested Class Summary

class

TagdocIndexReport.CustomResourceManagerImpl

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

TagdocIndexReport()

Method Summary

boolean	canGenerate(ClassMeta component)
protected void	executeReport(Locale locale)
String	getDescription(Locale locale)
protected Model	getModel()
String	getName(Locale locale)
protected String	getOutputDirectory()
String	getOutputName()
protected org.apache.maven.project.MavenProject	getProject()
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()
boolean	usePageLinkBar()

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

TagdocIndexReport

public TagdocIndexReport()

Method Detail

executeReport

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

Specified by:

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

Throws:

org.apache.maven.reporting.MavenReportException

canGenerate

public boolean canGenerate(ClassMeta component)

usePageLinkBar

public boolean usePageLinkBar()

getProject

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

Specified by:

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

getOutputDirectory

protected String getOutputDirectory()

Specified by:

getOutputDirectory 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

getName

public String getName(Locale locale)

getDescription

public String getDescription(Locale locale)

getOutputName

public String getOutputName()

getModel

protected Model getModel()