org.codehaus.mojo.taglist.beans

Class FileReport

public class FileReport extends Object implements Comparable

Report for a file.

Author: Fabrice Bellingard

Constructor Summary
FileReport(File file)
Constructor
Method Summary
voidaddComment(String comment, int lineIndex)
Adds a new entry to the list of tags found for this file report
intcompareTo(Object o)
Cf. overriden method documentation.
StringgetClassName()
Returns the complete name of the analysed class, for instance: org.codehaus.mojo.taglist.beans.FileReport
StringgetClassNameWithSlash()
Returns the path corresponding to the analysed class, for instance: org/apache/maven/plugins/taglist/beans/FileReport
StringgetComment(Integer lineIndex)
Returns the comment for the corresponding line index
CollectiongetLineIndexes()
Returns the list of the comment line indexes

Constructor Detail

FileReport

public FileReport(File file)
Constructor

Parameters: className the complete name of analysed class tagListing Map of the comments

Method Detail

addComment

public void addComment(String comment, int lineIndex)
Adds a new entry to the list of tags found for this file report

Parameters: comment lineIndex

compareTo

public int compareTo(Object o)
Cf. overriden method documentation.

See Also: Comparable#compareTo(Object)

getClassName

public String getClassName()
Returns the complete name of the analysed class, for instance: org.codehaus.mojo.taglist.beans.FileReport

Returns: the full class name

getClassNameWithSlash

public String getClassNameWithSlash()
Returns the path corresponding to the analysed class, for instance: org/apache/maven/plugins/taglist/beans/FileReport

Returns: the file path

getComment

public String getComment(Integer lineIndex)
Returns the comment for the corresponding line index

Parameters: lineIndex the index of the line

Returns: the comment

getLineIndexes

public Collection getLineIndexes()
Returns the list of the comment line indexes

Returns: Collection of Integer

Copyright © 2005-2007 null. All Rights Reserved.