|
||||||||||
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(File file,
String encoding)
Constructor. |
Method Summary | |
---|---|
void |
addComment(String comment,
int lineIndex)
Adds a new entry to the list of tags found for this file report. |
int |
compareTo(Object o)
|
boolean |
equals(Object r)
|
String |
getClassName()
Returns the complete name of the analyzed class, for instance: org.codehaus.mojo.taglist.beans.FileReport. |
String |
getClassNameWithSlash()
Returns the path corresponding to the analyzed class, for instance: org/apache/maven/plugins/taglist/beans/FileReport. |
String |
getComment(Integer lineIndex)
Returns the comment for the corresponding line index. |
Collection |
getLineIndexes()
Returns the list of the comment line indexes. |
int |
hashCode()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FileReport(File file, String encoding)
file
- The file to analyze.encoding
- the file encoding to use for the report.Method Detail |
---|
public void addComment(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 String getClassNameWithSlash()
public String getClassName()
public Collection getLineIndexes()
public String getComment(Integer lineIndex)
lineIndex
- the index of the line.
public int compareTo(Object o)
compareTo
in interface Comparable
Comparable.compareTo(Object)
public boolean equals(Object r)
equals
in class Object
Object.equals(Object)
public int hashCode()
hashCode
in class Object
Object.hashCode()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |