org.codehaus.mojo.taglist.beans
Class TagReport

java.lang.Object
  extended by org.codehaus.mojo.taglist.beans.TagReport
All Implemented Interfaces:
Comparable

public class TagReport
extends Object
implements Comparable

Report of the scan for a specific tag.

Author:
Fabrice Bellingard

Constructor Summary
TagReport(String displayName, String linkName)
          Constructor.
 
Method Summary
 void addTagString(String tagString)
          Add a tag string to this tag class.
 int compareTo(Object o)
          
 boolean equals(Object r)
          
 FileReport getFileReport(File file, String encoding)
          Returns the FileReport object corresponding to this file.
 Collection getFileReports()
          Returns the collection of file reports for the tag.
 String getHTMLSafeLinkName()
          Returns a HTML safe link name for this tag report.
 int getTagCount()
          Gives the number of comments found for that tag.
 String getTagName()
          Returns the name of the tag class that was looked for.
 String[] getTagStrings()
          Get a list of tag strings used by this tag report.
 int hashCode()
          
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TagReport

public TagReport(String displayName,
                 String linkName)
Constructor.

Parameters:
displayName - the tag class's name.
linkName - a HTML safe link name for this report.
Method Detail

getFileReport

public FileReport getFileReport(File file,
                                String encoding)
Returns the FileReport object corresponding to this file. If it does not exist yet, it will be created.

Parameters:
file - the file being analyzed.
encoding - the character encoding of the file
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.

getTagName

public String getTagName()
Returns the name of the tag class that was looked for.

Returns:
the name of the tag class.

getHTMLSafeLinkName

public String getHTMLSafeLinkName()
Returns a HTML safe link name for this tag report.

Returns:
a HTML safe link name.

getTagCount

public int getTagCount()
Gives the number of comments found for that tag.

Returns:
the number of comments.

compareTo

public int compareTo(Object o)

Specified by:
compareTo in interface Comparable
See Also:
Comparable.compareTo(Object)

addTagString

public void addTagString(String tagString)
Add a tag string to this tag class. Each tag class contains 1 or more tag strings that are used for matching 'todo' strings in the scanned code.

Parameters:
tagString - the tag string to add.

getTagStrings

public String[] getTagStrings()
Get a list of tag strings used by this tag report.

Returns:
a list of tag strings.

equals

public boolean equals(Object r)

Overrides:
equals in class Object
See Also:
Object.equals(Object)

hashCode

public int hashCode()

Overrides:
hashCode in class Object
See Also:
Object.hashCode()


Copyright © 2005-2014 Codehaus. All Rights Reserved.