org.codehaus.mojo.taglist.beans

Class TagReport

public class TagReport extends Object implements Comparable

Report of the scan for a specific tag

Author: Fabrice Bellingard

Constructor Summary
	TagReport(String tagName) Constructor

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

Constructor Detail

TagReport

public TagReport(String tagName)

Constructor

Parameters: tagName fileReports

Method Detail

compareTo

public int compareTo(Object o)

Cf. overriden method documentation.

See Also: Comparable#compareTo(Object)

getFileReport

public FileReport getFileReport(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 Collection getFileReports()

Returns the collection of file reports for the tag.

Returns: a Collection of FileReport objects.

getTagCount

public int getTagCount()

Gives the number of comments found for that tag.

Returns: the number of comments

getTagName

public String getTagName()

Returns the name of the tag that was looked for.

Returns: the name of the tag.

Copyright © 2005-2007 null. All Rights Reserved.