Package org.sonarsource.analyzer.commons.checks.verifier.internal

Class UnderlinedRange

java.lang.Object

org.sonarsource.analyzer.commons.checks.verifier.internal.UnderlinedRange

All Implemented Interfaces:

Comparable<UnderlinedRange>

public class UnderlinedRange
extends Object
implements Comparable<UnderlinedRange>

Used to specify the location of an issue in source code.

Field Summary

Fields

Modifier and Type	Field	Description
int	column	start at 1, column number of the first character of the token
int	endColumn	start at 1, column number of the last character of the token if the token has only one character, endColumn == column
int	endLine	start at 1, line number of the last character of the token if the token is on a single line, endLine == line
int	line	start at 1, line number of the first character of the token

Constructor Summary

Constructors

Constructor	Description
UnderlinedRange(int line, int column, int endLine, int endColumn)

Method Summary

Modifier and Type	Method	Description
int	compareTo(UnderlinedRange other)
boolean	equals(Object other)
int	hashCode()
String	toString()
void	underline(int indent, StringBuilder textLine)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

line

public final int line

start at 1, line number of the first character of the token

column

public final int column

start at 1, column number of the first character of the token

endLine

public final int endLine

start at 1, line number of the last character of the token if the token is on a single line, endLine == line

endColumn

public final int endColumn

start at 1, column number of the last character of the token if the token has only one character, endColumn == column

Constructor Detail

UnderlinedRange

public UnderlinedRange(int line,
                       int column,
                       int endLine,
                       int endColumn)

Parameters:

line - , start at 1, line number of the first character of the token, same as TokenLocation#startLine()

column - , start at 1, column number of the first character of the token, same as TokenLocation#startLineOffset()+1,

endLine - , start at 1, line number of the last character of the token, same as TokenLocation#endLine(), if the token is on a single line, endLine == line

endColumn - , start at 1, column number of the last character of the token, same as TokenLocation#endLineOffset(), if the token has only one character, endColumn == column

Method Detail

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(UnderlinedRange other)

Specified by:

compareTo in interface Comparable<UnderlinedRange>

toString

public String toString()

Overrides:

toString in class Object

underline

public void underline(int indent,
                      StringBuilder textLine)