com.puppycrawl.tools.checkstyle.api

Class Comment

class Comment extends Object implements TextBlock

Representation of the comment block.

Author: o_sukhodolsky

Constructor Summary
Comment(String[] aText, int aFirstCol, int aLastLine, int aLastCol)
Creates new instance.
Method Summary
intgetEndColNo()
{@inheritDoc}
intgetEndLineNo()
{@inheritDoc}
intgetStartColNo()
{@inheritDoc}
intgetStartLineNo()
{@inheritDoc}
String[]getText()
{@inheritDoc}
booleanintersects(int aStartLineNo, int aStartColNo, int aEndLineNo, int aEndColNo)
{@inheritDoc}
StringtoString()
{@inheritDoc}

Constructor Detail

Comment

public Comment(String[] aText, int aFirstCol, int aLastLine, int aLastCol)
Creates new instance.

Parameters: 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

getEndColNo

public int getEndColNo()
{@inheritDoc}

getEndLineNo

public final int getEndLineNo()
{@inheritDoc}

getStartColNo

public int getStartColNo()
{@inheritDoc}

getStartLineNo

public final int getStartLineNo()
{@inheritDoc}

getText

public final String[] getText()
{@inheritDoc}

intersects

public boolean intersects(int aStartLineNo, int aStartColNo, int aEndLineNo, int aEndColNo)
{@inheritDoc}

toString

public String toString()
{@inheritDoc}