org.codehaus.mojo.taglist.beans
Class TagReport

java.lang.Object
  org.codehaus.mojo.taglist.beans.TagReport

All Implemented Interfaces:

java.lang.Comparable

public class TagReport
extends java.lang.Object
implements java.lang.Comparable

Report of the scan for a specific tag

Author:

Fabrice Bellingard

Constructor Summary

TagReport(java.lang.String tagName)
Constructor

Method Summary

int	compareTo(java.lang.Object o) Cf.
FileReport	getFileReport(java.io.File file) Returns the FileReport object corresponding to this file.
java.util.Collection	getFileReports() Returns the collection of file reports for the tag.
int	getTagCount() Gives the number of comments found for that tag.
java.lang.String	getTagName() Returns the name of the tag that was looked for.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TagReport

public TagReport(java.lang.String tagName)

Constructor

Parameters:

tagName -

fileReports -

Method Detail

getFileReport

public FileReport getFileReport(java.io.File file)

Returns the FileReport object corresponding to this file. If it does not exist yet, it will be created.

Parameters:

file - the file being analysed

Returns:

a FileReport object for this file

getFileReports

public java.util.Collection getFileReports()

Returns the collection of file reports for the tag.

Returns:

a Collection of FileReport objects.

getTagName

public java.lang.String getTagName()

Returns the name of the tag that was looked for.

Returns:

the name of the tag.

getTagCount

public int getTagCount()

Gives the number of comments found for that tag.

Returns:

the number of comments

compareTo

public int compareTo(java.lang.Object o)

Cf. overriden method documentation.

Specified by:

compareTo in interface java.lang.Comparable

See Also:

Comparable.compareTo(Object)