org.codehaus.mojo.taglist
Class TagListReport

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.reporting.AbstractMavenReport
          extended by org.codehaus.mojo.taglist.TagListReport
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport

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

Scans the source files for tags and generates a report on their occurrences.

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.
 java.util.List constructSourceDirs()
          Construct the list of source directories to analyse.
protected  void executeReport(java.util.Locale locale)
          Cf.
 java.util.ResourceBundle getBundle()
          Returns the correct resource bundle according to the locale.
 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 isEmptyComments()
          Tells whether to look for tags without comments.
 boolean isMultipleLineComments()
          Tells whether to look for comments over multiple lines.
 boolean isShowEmptyDetails()
          Tells whether to generate details for tags with zero occurrences.
 
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
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

TagListReport

public TagListReport()
Method Detail

executeReport

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

Specified by:
executeReport in class org.apache.maven.reporting.AbstractMavenReport
Throws:
org.apache.maven.reporting.MavenReportException
See Also:
AbstractMavenReport.executeReport(java.util.Locale)

canGenerateReport

public boolean canGenerateReport()
Cf. overriden method documentation.

Specified by:
canGenerateReport in interface org.apache.maven.reporting.MavenReport
Overrides:
canGenerateReport in class org.apache.maven.reporting.AbstractMavenReport
See Also:
MavenReport.canGenerateReport()

constructSourceDirs

public java.util.List constructSourceDirs()
Construct the list of source directories to analyse.

Returns:
the list of dirs.

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 to look for comments over multiple lines.

Returns:
Returns true if the analyser should look for multiple lines.

isEmptyComments

public boolean isEmptyComments()
Tells whether to look for tags without comments.

Returns:
the emptyComments.

isShowEmptyDetails

public boolean isShowEmptyDetails()
Tells whether to generate details for tags with zero occurrences.

Returns:
the showEmptyTags.

getSiteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
Cf. overriden method documentation.

Specified by:
getSiteRenderer in class org.apache.maven.reporting.AbstractMavenReport
See Also:
AbstractMavenReport.getSiteRenderer()

getOutputDirectory

protected java.lang.String getOutputDirectory()
Cf. overriden method documentation.

Specified by:
getOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport
See Also:
AbstractMavenReport.getOutputDirectory()

getProject

public org.apache.maven.project.MavenProject getProject()
Cf. overriden method documentation.

Specified by:
getProject in class org.apache.maven.reporting.AbstractMavenReport
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()

getBundle

public java.util.ResourceBundle getBundle()
Returns the correct resource bundle according to the locale.

Returns:
the bundle correponding to the locale used for rendering the report.


Copyright © 2005-2009. All Rights Reserved.