org.apache.james.mailet
Class MailetdocsMojo

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

All Implemented Interfaces:

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

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

Generates catalog and reports on mailets and matchers.

Notes

• Should only used as a report.
• Mailets are instantiated during report production.

Since:

0.1

Is defined by the goal name:

mailetdocs

Requires the dependencies in this specified scope:

compile

Nested Class Summary

private static class

MailetdocsMojo.TypePredicate Extracts only a given type from a list.

Field Summary

private java.io.File	outputDirectory The output directory.
private org.apache.maven.project.MavenProject	project Maven Internal: The Project descriptor.
private org.apache.maven.doxia.siterenderer.Renderer	siteRenderer Maven Internal: The Doxia Site Renderer.

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

MailetdocsMojo()

Method Summary

protected void	executeReport(java.util.Locale locale)
java.lang.String	getDescription(java.util.Locale arg0)
java.lang.String	getName(java.util.Locale arg0)
protected java.lang.String	getOutputDirectory()
java.lang.String	getOutputName()
protected org.apache.maven.project.MavenProject	getProject()
org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()
private void	outputDescriptorIndex(java.util.List descriptors, java.lang.String title)
private void	outputDescriptorList(java.util.List descriptors, java.lang.String title)
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, 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

Field Detail

siteRenderer

private org.apache.maven.doxia.siterenderer.Renderer siteRenderer

Maven Internal: The Doxia Site Renderer.

Is a Plexus component defined by:

project

private org.apache.maven.project.MavenProject project

Maven Internal: The Project descriptor.

Is defined by:

expression:

${project}

Is readonly.

Is required.

outputDirectory

private java.io.File outputDirectory

The output directory.

Since:

0.1

Is defined by:

expression:

${project.reporting.outputDirectory}

Is required.

Constructor Detail

MailetdocsMojo

public MailetdocsMojo()

Method Detail

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

outputDescriptorIndex

private void outputDescriptorIndex(java.util.List descriptors,
                                   java.lang.String title)

outputDescriptorList

private void outputDescriptorList(java.util.List descriptors,
                                  java.lang.String title)

getOutputDirectory

protected java.lang.String getOutputDirectory()

Specified by:

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

getSiteRenderer

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

Specified by:

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

Returns:

Returns the siteRenderer.

getProject

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

Specified by:

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

getDescription

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

getName

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

getOutputName

public java.lang.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.