org.codehaus.mojo.taglist
Class FileAnalyser

java.lang.Object
  extended by org.codehaus.mojo.taglist.FileAnalyser

public class FileAnalyser
extends Object

Class that analyzes a file with a special comment tag. For instance:

 // TODO: Example of an Eclipse/IntelliJ-like "todo" tag
 

Author:
Fabrice Bellingard

Constructor Summary
FileAnalyser(TagListReport report, ArrayList tagClasses)
          Constructor.
 
Method Summary
 Collection execute()
          Execute the analysis for the configuration given by the TagListReport.
 void scanFile(File file)
          Scans a file to look for task tags.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FileAnalyser

public FileAnalyser(TagListReport report,
                    ArrayList tagClasses)
Constructor.

Parameters:
report - the MOJO that is using this analyzer.
tagClasses - the array of tag classes to use for searching
Method Detail

execute

public Collection execute()
                   throws org.apache.maven.reporting.MavenReportException
Execute the analysis for the configuration given by the TagListReport.

Returns:
a collection of TagReport objects.
Throws:
org.apache.maven.reporting.MavenReportException - the Maven report exception.

scanFile

public void scanFile(File file)
Scans a file to look for task tags.

Parameters:
file - the file to scan.


Copyright © 2005-2014 Codehaus. All Rights Reserved.