ch.fortysix.maven.report.taglist
Class PostmanTaglistReportMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          ch.fortysix.maven.report.AbstractReportMojo
              ch.fortysix.maven.report.taglist.PostmanTaglistReportMojo

All Implemented Interfaces:

groovy.lang.GroovyObject, org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport

public class PostmanTaglistReportMojo
extends AbstractReportMojo
implements groovy.lang.GroovyObject

This plugin is able to send 'reminder mails' based on the findings of the org.codehaus.mojo:taglist-maven-plugin. One should use at least version 2.4 of the taglist-plugin

Author:

Domi

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

PostmanTaglistReportMojo()

Method Summary

void	addTagClasse(TagClass tagClass)
protected void	executePostmanReport(Locale locale) do the report and send the mails
groovy.lang.MetaClass	getMetaClass()
String	getNlsPrefix() prefix within the bundle files - has to be overwritten by implemtors!
String	getOutputName()
Object	getProperty(String name)
String	getSubjectPostFix() returns the postfix for the mail subject
List	getTagClasses()
File	getTaglistReportHtml()
File	getTaglistReportXml()
Object	invokeMethod(String name, Object args)
Map	prepareAnchers() Parses the taglist.html and prepares a map with the mapping 'tagClass.displayName:htmlAncher'.
void	setMetaClass(groovy.lang.MetaClass metaClass)
void	setProperty(String name, Object value)
void	setSubjectPostFix(String value)
void	setTagClasses(List value)
void	setTaglistReportHtml(File value)
void	setTaglistReportXml(File value)

Methods inherited from class ch.fortysix.maven.report.AbstractReportMojo

executeReport, getActualDocuSite, getBundle, getDescription, getDocuSite, getFailonerror, getFrom, getMailAltConfig, getMailcontenttype, getMailhost, getMailpassword, getMailport, getMailSender, getMailssl, getMailuser, getMultipartSupported, getName, getOutputDirectory, getProject, getSendReport, getSession, getSiteRenderer, getSkipMails, getSourceEncoding, getSubject, isFailonerror, isMailAltConfig, isMailssl, isMultipartSupported, isSkipMails, setDocuSite, setFailonerror, setFrom, setMailAltConfig, setMailcontenttype, setMailhost, setMailpassword, setMailport, setMailSender, setMailssl, setMailuser, setMultipartSupported, setOutputDirectory, setProject, setSendReport, setSession, setSkipMails, setSourceEncoding, setSubject

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

PostmanTaglistReportMojo

public PostmanTaglistReportMojo()

Method Detail

setSubjectPostFix

public void setSubjectPostFix(String value)

getTaglistReportXml

public File getTaglistReportXml()

setTaglistReportXml

public void setTaglistReportXml(File value)

getTaglistReportHtml

public File getTaglistReportHtml()

setTaglistReportHtml

public void setTaglistReportHtml(File value)

getTagClasses

public List getTagClasses()

setTagClasses

public void setTagClasses(List value)

getSubjectPostFix

public String getSubjectPostFix()

Description copied from class: AbstractReportMojo

returns the postfix for the mail subject

Specified by:

getSubjectPostFix in class AbstractReportMojo

getNlsPrefix

public String getNlsPrefix()

Description copied from class: AbstractReportMojo

prefix within the bundle files - has to be overwritten by implemtors!

Specified by:

getNlsPrefix in class AbstractReportMojo

getOutputName

public String getOutputName()

Specified by:

getOutputName in interface org.apache.maven.reporting.MavenReport

addTagClasse

public void addTagClasse(TagClass tagClass)

executePostmanReport

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

do the report and send the mails

Specified by:

executePostmanReport in class AbstractReportMojo

Throws:

org.apache.maven.reporting.MavenReportException

prepareAnchers

public Map prepareAnchers()

Parses the taglist.html and prepares a map with the mapping 'tagClass.displayName:htmlAncher'.

getMetaClass

public groovy.lang.MetaClass getMetaClass()

Specified by:

getMetaClass in interface groovy.lang.GroovyObject

Overrides:

getMetaClass in class AbstractReportMojo

setMetaClass

public void setMetaClass(groovy.lang.MetaClass metaClass)

Specified by:

setMetaClass in interface groovy.lang.GroovyObject

Overrides:

setMetaClass in class AbstractReportMojo

invokeMethod

public Object invokeMethod(String name,
                           Object args)

Specified by:

invokeMethod in interface groovy.lang.GroovyObject

Overrides:

invokeMethod in class AbstractReportMojo

getProperty

public Object getProperty(String name)

Specified by:

getProperty in interface groovy.lang.GroovyObject

Overrides:

getProperty in class AbstractReportMojo

setProperty

public void setProperty(String name,
                        Object value)

Specified by:

setProperty in interface groovy.lang.GroovyObject

Overrides:

setProperty in class AbstractReportMojo