org.codehaus.mojo.taglist
Class TagListReport

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          org.codehaus.mojo.taglist.TagListReport

All Implemented Interfaces:

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

public class TagListReport

extends org.apache.maven.reporting.AbstractMavenReport

MOJO for the tag list report.

Author:

Fabrice Bellingard

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

TagListReport()

Method Summary

boolean	canGenerateReport() Cf.
protected void	executeReport(java.util.Locale locale) Cf.
java.lang.String	getDescription(java.util.Locale locale) Cf.
java.lang.String	getName(java.util.Locale locale) Cf.
protected java.lang.String	getOutputDirectory() Cf.
java.lang.String	getOutputName() Cf.
org.apache.maven.project.MavenProject	getProject() Cf.
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer() Cf.
java.lang.String[]	getTags() Returns the tags to look for.
boolean	isMultipleLineComments() Tells whether we should look for comments over multiple lines

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

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

TagListReport

public TagListReport()

Method Detail

executeReport

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

Cf. overriden method documentation.

Throws:

org.apache.maven.reporting.MavenReportException

See Also:

AbstractMavenReport.executeReport(java.util.Locale)

canGenerateReport

public boolean canGenerateReport()

Cf. overriden method documentation.

See Also:

MavenReport.canGenerateReport()

getTags

public java.lang.String[] getTags()

Returns the tags to look for.

Returns:

a collection of String objects representing the tag names.

isMultipleLineComments

public boolean isMultipleLineComments()

Tells whether we should look for comments over multiple lines

Returns:

Returns true if the analyser should look for multiple lines.

getSiteRenderer

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

Cf. overriden method documentation.

See Also:

AbstractMavenReport.getSiteRenderer()

getOutputDirectory

protected java.lang.String getOutputDirectory()

Cf. overriden method documentation.

See Also:

AbstractMavenReport.getOutputDirectory()

getProject

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

Cf. overriden method documentation.

See Also:

AbstractMavenReport.getProject()

getDescription

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

Cf. overriden method documentation.

See Also:

MavenReport.getDescription(java.util.Locale)

getName

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

Cf. overriden method documentation.

See Also:

MavenReport.getName(java.util.Locale)

getOutputName

public java.lang.String getOutputName()

Cf. overriden method documentation.

See Also:

MavenReport.getOutputName()