org.codehaus.mojo.taglist.beans
Class FileReport

java.lang.Object
  extended byorg.codehaus.mojo.taglist.beans.FileReport
All Implemented Interfaces:
java.lang.Comparable

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

Report for a file.

Author:
Fabrice Bellingard

Constructor Summary
FileReport(java.io.File file)
          Constructor
 
Method Summary
 void addComment(java.lang.String comment, int lineIndex)
          Adds a new entry to the list of tags found for this file report
 int compareTo(java.lang.Object o)
          Cf.
 java.lang.String getClassName()
          Returns the complete name of the analysed class, for instance: org.codehaus.mojo.taglist.beans.FileReport
 java.lang.String getClassNameWithSlash()
          Returns the path corresponding to the analysed class, for instance: org/apache/maven/plugins/taglist/beans/FileReport
 java.lang.String getComment(java.lang.Integer lineIndex)
          Returns the comment for the corresponding line index
 java.util.Collection getLineIndexes()
          Returns the list of the comment line indexes
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FileReport

public FileReport(java.io.File file)
Constructor

Method Detail

addComment

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

Parameters:
comment -
lineIndex -

getClassNameWithSlash

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

Returns:
the file path

getClassName

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

Returns:
the full class name

getLineIndexes

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

Returns:
Collection of Integer

getComment

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

Parameters:
lineIndex - the index of the line
Returns:
the comment

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)


Copyright © 2005-2007 null. All Rights Reserved.