|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.puppycrawl.tools.checkstyle.api.FileContents
Represents the contents of a file.
Constructor Summary | |
FileContents(java.lang.String aFilename,
java.lang.String[] aLines)
Creates a new FileContents instance. |
Method Summary | |
java.util.Map |
getCComments()
Returns a map of all C style comments. |
java.util.Map |
getCppComments()
Returns a map of all the C++ style comments. |
java.lang.String |
getFilename()
|
java.lang.String[] |
getJavadocBefore(int aLineNo)
Returns the Javadoc comment before the specified line. |
java.lang.String[] |
getLines()
|
void |
reportCComment(int aStartLineNo,
int aStartColNo,
int aEndLineNo,
int aEndColNo)
Report the location of a C-style comment. |
void |
reportCppComment(int aStartLineNo,
int aStartColNo)
Report the location of a C++ style comment. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public FileContents(java.lang.String aFilename, java.lang.String[] aLines)
FileContents
instance.
aFilename
- name of the fileaLines
- the contents of the fileMethod Detail |
public void reportCppComment(int aStartLineNo, int aStartColNo)
aStartLineNo
- the starting line numberaStartColNo
- the starting column numberpublic java.util.Map getCppComments()
public void reportCComment(int aStartLineNo, int aStartColNo, int aEndLineNo, int aEndColNo)
aStartLineNo
- the starting line numberaStartColNo
- the starting column numberaEndLineNo
- the ending line numberaEndColNo
- the ending column numberpublic java.util.Map getCComments()
public java.lang.String[] getJavadocBefore(int aLineNo)
null
means there is no such comment.
aLineNo
- the line number to check before
null
if nonepublic java.lang.String[] getLines()
public java.lang.String getFilename()
|
Back to the Checkstyle Home Page | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |