com.github.sbaudoin.sonar.plugins.shellcheck.highlighting

Class HighlightingData

java.lang.Object

com.github.sbaudoin.sonar.plugins.shellcheck.highlighting.HighlightingData

public class HighlightingData
extends Object

Class that stores the parameters a portion of Shell script to be highlighted and that is responsible for highlighting code in Sonar

Constructor Summary

Constructors

Constructor and Description
HighlightingData(int startLine, int startColumnIndex, int endLine, int endColumnIndex, org.sonar.api.batch.sensor.highlighting.TypeOfText typeOfText) Constructor

Method Summary

Modifier and Type	Method and Description
int	getEndColumnIndex() Returns the column number where the highlighted portion of code ends
int	getEndLine() Returns the line number where the highlighted portion of code ends
int	getStartColumnIndex() Returns the column number where the highlighted portion of code starts
int	getStartLine() Returns the line number where the highlighted portion of code starts
org.sonar.api.batch.sensor.highlighting.TypeOfText	getTypeOfText() Returns the type of text
void	highlight(org.sonar.api.batch.sensor.highlighting.NewHighlighting highlighting) Highlights the portion of code in SonarQube as described by this class

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HighlightingData

public HighlightingData(int startLine,
                        int startColumnIndex,
                        int endLine,
                        int endColumnIndex,
                        org.sonar.api.batch.sensor.highlighting.TypeOfText typeOfText)

Constructor

Parameters:

startLine - the line number where the highlighted portion of code starts

startColumnIndex - the column number where the highlighted portion of code starts

endLine - the line number where the highlighted portion of code ends

endColumnIndex - the column number where the highlighted portion of code ends (this column is not part of the highlighting)

typeOfText - the type of text. Depending on this parameter, the highlighting in SonarQube will be different.

Method Detail

highlight

public void highlight(org.sonar.api.batch.sensor.highlighting.NewHighlighting highlighting)

Highlights the portion of code in SonarQube as described by this class

Parameters:

highlighting - SonarQube's highlighting for this portion of code

getStartLine

public int getStartLine()

Returns the line number where the highlighted portion of code starts

Returns:

the line number where the highlighted portion of code starts

getStartColumnIndex

public int getStartColumnIndex()

Returns the column number where the highlighted portion of code starts

Returns:

the column number where the highlighted portion of code starts

getEndLine

public int getEndLine()

Returns the line number where the highlighted portion of code ends

Returns:

the line number where the highlighted portion of code ends

getEndColumnIndex

public int getEndColumnIndex()

Returns the column number where the highlighted portion of code ends

Returns:

the column number where the highlighted portion of code ends

getTypeOfText

public org.sonar.api.batch.sensor.highlighting.TypeOfText getTypeOfText()

Returns the type of text

Returns:

the type of text