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:
ContextEnabled, Mojo, MavenReport

public class TagListReport
extends AbstractMavenReport

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

Author:
Fabrice Bellingard
Is defined by the goal name:
taglist

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()
          
 List constructSourceDirs()
          Construct the list of source directories to analyze.
protected  void executeReport(Locale locale)
          
 ResourceBundle getBundle()
          Returns the correct resource bundle according to the locale.
 String getDescription(Locale locale)
          
 String getEncoding()
          Returns the character encoding of the source files.
 Locale getLocale()
          Returns the Locale of the source files.
 String getName(Locale locale)
          
protected  String getOutputDirectory()
          
 String getOutputName()
          
 MavenProject getProject()
          
protected  org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
          
protected  String getXMLOutputDirectory()
          Get the absolute path to the XML output directory.
 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(Locale locale)
                      throws MavenReportException

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

canGenerateReport

public boolean canGenerateReport()

Specified by:
canGenerateReport in interface MavenReport
Overrides:
canGenerateReport in class AbstractMavenReport
See Also:
MavenReport.canGenerateReport()

constructSourceDirs

public List constructSourceDirs()
Construct the list of source directories to analyze.

Returns:
the list of dirs.

getEncoding

public String getEncoding()
Returns the character encoding of the source files.

Returns:
The character encoding of the source files.

getLocale

public Locale getLocale()
Returns the Locale of the source files.

Returns:
The Locale of the source files.

isMultipleLineComments

public boolean isMultipleLineComments()
Tells whether to look for comments over multiple lines.

Returns:
Returns true if the analyzer 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()

Specified by:
getSiteRenderer in class AbstractMavenReport
See Also:
AbstractMavenReport.getSiteRenderer()

getOutputDirectory

protected String getOutputDirectory()

Specified by:
getOutputDirectory in class AbstractMavenReport
See Also:
AbstractMavenReport.getOutputDirectory()

getXMLOutputDirectory

protected String getXMLOutputDirectory()
Get the absolute path to the XML output directory.

Returns:
string of the absolute path.

getProject

public MavenProject getProject()

Specified by:
getProject in class AbstractMavenReport
See Also:
AbstractMavenReport.getProject()

getDescription

public String getDescription(Locale locale)

See Also:
MavenReport.getDescription(java.util.Locale)

getName

public String getName(Locale locale)

See Also:
MavenReport.getName(java.util.Locale)

getOutputName

public String getOutputName()

See Also:
MavenReport.getOutputName()

getBundle

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

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


Copyright © 2005-2012 Codehaus. All Rights Reserved.