com.puppycrawl.tools.checkstyle.api

Class Comment

java.lang.Object

com.puppycrawl.tools.checkstyle.api.Comment

All Implemented Interfaces:

TextBlock

public class Comment
extends Object
implements TextBlock

Representation of the comment block.

Author:

o_sukhodolsky

Constructor Summary

Constructors

Constructor and Description
Comment(String[] text, int firstCol, int lastLine, int lastCol) Creates new instance.

Method Summary

Methods

Modifier and Type	Method and Description
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 startLineNo, int startColNo, int endLineNo, int endColNo) 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

Comment

public Comment(String[] text,
       int firstCol,
       int lastLine,
       int lastCol)

Creates new instance.

Parameters:

text - the lines that make up the comment.

firstCol - number of the first column of the comment.

lastLine - number of the last line of the comment.

lastCol - number of the last column of the comment.

Method Detail

getText

public final String[] getText()

The text content of the text block. Each line is represented by one array entry. The linebreak characters are not part of the text content.

Specified by:

getText in interface TextBlock

Returns:

the text content of the text block.

getStartLineNo

public final int getStartLineNo()

The line in the inputfile where the text block starts. Counting starts from 1.

Specified by:

getStartLineNo in interface TextBlock

Returns:

first line of the text block

getEndLineNo

public final int getEndLineNo()

The last line of the text block in the inputfile. Counting starts from 1.

Specified by:

getEndLineNo in interface TextBlock

Returns:

last line of the text block

getStartColNo

public int getStartColNo()

The column in the inputfile where the text block starts. Counting starts from 0.

Specified by:

getStartColNo in interface TextBlock

Returns:

first line of the text block

getEndColNo

public int getEndColNo()

The column in the inputfile where the text block ends. Counting starts from 0.

Specified by:

getEndColNo in interface TextBlock

Returns:

last line of the text block

intersects

public boolean intersects(int startLineNo,
                 int startColNo,
                 int endLineNo,
                 int endColNo)

Checks if this comment intersects with a specified part of the file.

Specified by:

intersects in interface TextBlock

Parameters:

startLineNo - the starting line number in the file

startColNo - the starting column number in the file

endLineNo - the ending line number in the file

endColNo - the ending column number in the file

Returns:

true if the positions intersects with this comment.

toString

public String toString()

Overrides:

toString in class Object