org.codehaus.mojo.taglist

Class FileAnalyser

public class FileAnalyser extends 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

UNKNOWN: : This is another example of "todo" tag

Constructor Summary
FileAnalyser(TagListReport report)
Constructor
Method Summary
Collectionexecute()
Execute the analysis for the configuration given by the TagListReport.
voidscanFile(File file)
Scans a file to look for task tags.

Constructor Detail

FileAnalyser

public FileAnalyser(TagListReport report)
Constructor

Parameters: report the MOJO that is using this analyser

Method Detail

execute

public Collection execute()
Execute the analysis for the configuration given by the TagListReport.

Returns: a collection of TagReport objects

scanFile

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

Parameters: file the file to scan

Copyright © 2005-2007 null. All Rights Reserved.