org.codehaus.mojo.taglist
Class FileAnalyser

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

public class FileAnalyser
extends java.lang.Object

Class that analyses 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)
Constructor

Method Summary

java.util.Collection	execute() Execute the analysis for the configuration given by the TagListReport.
void	scanFile(java.io.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)

Constructor

Parameters:

report - the MOJO that is using this analyser

Method Detail

execute

public java.util.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

scanFile

public void scanFile(java.io.File file)

Scans a file to look for task tags.

Parameters:

file - the file to scan