|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.mojo.taglist.beans.FileReport
public class FileReport
Report for a file.
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 |
---|
public FileReport(java.io.File file)
file
- The file to analyse.Method Detail |
---|
public void addComment(java.lang.String comment, int lineIndex)
comment
- the comment string containing the 'todo'.lineIndex
- the line number of the comment (or first line if multi-lined).public java.lang.String getClassNameWithSlash()
public java.lang.String getClassName()
public java.util.Collection getLineIndexes()
public java.lang.String getComment(java.lang.Integer lineIndex)
lineIndex
- the index of the line.
public int compareTo(java.lang.Object o)
compareTo
in interface java.lang.Comparable
Comparable.compareTo(Object)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |