org.apache.james.mailet
Class AbstractMailetdocsReport

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          org.apache.james.mailet.AbstractMailetdocsReport

All Implemented Interfaces:

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

Direct Known Subclasses:

AggregateMailetdocsReport, MailetdocsReport

public abstract class AbstractMailetdocsReport
extends org.apache.maven.reporting.AbstractMavenReport

Base for singleton and aggregate reports on mailets and matchers.

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

AbstractMailetdocsReport()

Method Summary

protected abstract List<MailetMatcherDescriptor>	buildDescriptors(org.apache.maven.project.MavenProject project)
protected void	executeReport(Locale locale)
String	getDescription(Locale arg0)
String	getName(Locale arg0)
protected String	getOutputDirectory()
String	getOutputName()
protected org.apache.maven.project.MavenProject	getProject()
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()
void	setProject(org.apache.maven.project.MavenProject project) For testing purpose only.
void	setSiteRenderer(org.apache.maven.doxia.siterenderer.Renderer siteRenderer)

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

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

Constructor Detail

AbstractMailetdocsReport

public AbstractMailetdocsReport()

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

buildDescriptors

protected abstract List<MailetMatcherDescriptor> buildDescriptors(org.apache.maven.project.MavenProject project)

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

getDescription

public String getDescription(Locale arg0)

getName

public String getName(Locale arg0)

getOutputName

public String getOutputName()

setSiteRenderer

public void setSiteRenderer(org.apache.maven.doxia.siterenderer.Renderer siteRenderer)

Parameters:

siteRenderer - The siteRenderer to set.

setProject

public void setProject(org.apache.maven.project.MavenProject project)

For testing purpose only.

Parameters:

project - The project to set.