ch.fortysix.maven.plugin.postman.taglist
Class PostmanTaglistReportMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.codehaus.gmaven.mojo.GroovyMojo
          ch.fortysix.maven.plugin.postaman.AbstractSenderMojo
              ch.fortysix.maven.plugin.postman.taglist.PostmanTaglistReportMojo

All Implemented Interfaces:

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

public class PostmanTaglistReportMojo
extends AbstractSenderMojo
implements groovy.lang.GroovyObject

This goal 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 class ch.fortysix.maven.plugin.postaman.AbstractSenderMojo

context

Fields inherited from class org.codehaus.gmaven.mojo.GroovyMojo

__timeStamp, __timeStamp__239_neverHappen1260015629891, sanitizeErrors

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

PostmanTaglistReportMojo()

Method Summary

void	addTagClasse(TagClass tagClass)
List	collectMails()
void	executeMojo() do the report and send the mails
groovy.lang.MetaClass	getMetaClass()
Object	getProperty(String name)
Set	getReceivers()
Map	getTagClass2Anchor()
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'.
protected boolean	prepareMojo() prepare the mojo and tell whether the execution should be triggered or not
void	setMetaClass(groovy.lang.MetaClass metaClass)
void	setProperty(String name, Object value)
void	setReceivers(Set value)
void	setTagClass2Anchor(Map value)
void	setTagClasses(List value)
void	setTaglistReportHtml(File value)
void	setTaglistReportXml(File value)

Methods inherited from class ch.fortysix.maven.plugin.postaman.AbstractSenderMojo

execute, getFailonerror, getFrom, getHtmlMessage, getHtmlMessageFile, getMailAltConfig, getMailcontenttype, getMailhost, getMailpassword, getMailport, getMailSender, getMailssl, getMailuser, getMultipartSupported, getOutputDirectory, getProject, getSession, getSkip, getSourceEncoding, getSubject, getTextMessage, getTextMessageFile, isFailonerror, isMailAltConfig, isMailssl, isMultipartSupported, isSkip, setFailonerror, setFrom, setHtmlMessage, setHtmlMessageFile, setMailAltConfig, setMailcontenttype, setMailhost, setMailpassword, setMailport, setMailSender, setMailssl, setMailuser, setMultipartSupported, setOutputDirectory, setProject, setSession, setSkip, setSourceEncoding, setSubject, setTextMessage, setTextMessageFile

Methods inherited from class org.codehaus.gmaven.mojo.GroovyMojo

afterExecute, beforeExecute, fail, fail, getAnt

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

getReceivers

public Set getReceivers()

Overrides:

getReceivers in class AbstractSenderMojo

setReceivers

public void setReceivers(Set value)

Overrides:

setReceivers in class AbstractSenderMojo

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)

getTagClass2Anchor

public Map getTagClass2Anchor()

setTagClass2Anchor

public void setTagClass2Anchor(Map value)

addTagClasse

public void addTagClasse(TagClass tagClass)

prepareMojo

protected boolean prepareMojo()

Description copied from class: AbstractSenderMojo

prepare the mojo and tell whether the execution should be triggered or not

Specified by:

prepareMojo in class AbstractSenderMojo

collectMails

public List collectMails()

executeMojo

public void executeMojo()
                 throws org.apache.maven.plugin.MojoExecutionException,
                        org.apache.maven.plugin.MojoFailureException

do the report and send the mails

Specified by:

executeMojo in class AbstractSenderMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

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 AbstractSenderMojo

setMetaClass

public void setMetaClass(groovy.lang.MetaClass metaClass)

Specified by:

setMetaClass in interface groovy.lang.GroovyObject

Overrides:

setMetaClass in class AbstractSenderMojo

invokeMethod

public Object invokeMethod(String name,
                           Object args)

Specified by:

invokeMethod in interface groovy.lang.GroovyObject

Overrides:

invokeMethod in class AbstractSenderMojo

getProperty

public Object getProperty(String name)

Specified by:

getProperty in interface groovy.lang.GroovyObject

Overrides:

getProperty in class AbstractSenderMojo

setProperty

public void setProperty(String name,
                        Object value)

Specified by:

setProperty in interface groovy.lang.GroovyObject

Overrides:

setProperty in class AbstractSenderMojo