|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.puppycrawl.tools.checkstyle.api.Comment
public class Comment
Representation of the comment block.
Constructor Summary | |
---|---|
Comment(String[] aText,
int aFirstCol,
int aLastLine,
int aLastCol)
Creates new instance. |
Method Summary | |
---|---|
int |
getEndColNo()
The column in the inputfile where the text block ends. |
int |
getEndLineNo()
The last line of the text block in the inputfile. |
int |
getStartColNo()
The column in the inputfile where the text block starts. |
int |
getStartLineNo()
The line in the inputfile where the text block starts. |
String[] |
getText()
The text content of the text block. |
boolean |
intersects(int aStartLineNo,
int aStartColNo,
int aEndLineNo,
int aEndColNo)
Checks if this comment intersects with a specified part of the file. |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Comment(String[] aText, int aFirstCol, int aLastLine, int aLastCol)
aText
- the lines that make up the comment.aFirstCol
- number of the first column of the comment.aLastLine
- number of the last line of the comment.aLastCol
- number of the last column of the comment.Method Detail |
---|
public final String[] getText()
getText
in interface TextBlock
public final int getStartLineNo()
getStartLineNo
in interface TextBlock
public final int getEndLineNo()
getEndLineNo
in interface TextBlock
public int getStartColNo()
getStartColNo
in interface TextBlock
public int getEndColNo()
getEndColNo
in interface TextBlock
public boolean intersects(int aStartLineNo, int aStartColNo, int aEndLineNo, int aEndColNo)
intersects
in interface TextBlock
aStartLineNo
- the starting line number in the fileaStartColNo
- the starting column number in the fileaEndLineNo
- the ending line number in the fileaEndColNo
- the ending column number in the file
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |