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

Class ShellLocation

java.lang.Object

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

public class ShellLocation
extends Object

Wrapper class used to locate tokens in Shell scripts and help highlight them

Constructor Summary

Constructors

Constructor and Description
ShellLocation(String content, int line, int column, int characterOffset) Constructor
ShellLocation(String content, Token token) Constructor

Method Summary

Modifier and Type	Method and Description
int	column() Returns the column pointer remembered by this class
boolean	isSameAs(ShellLocation other) Tells if the passed ShellLocation has the same offset or not (this is a kind of shallow version of the equals method)
int	line() Returns the line pointer remembered by this class
char	readChar() Returns the character of the Shell script pointed to by the offset
ShellLocation	shift(int nbChar) Returns a ShellLocation that corresponds to this instance + line, column and offset parameters moved forward of the passed number of characters
String	toString() Returns a string representation of this class

Methods inherited from class java.lang.Object

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

Constructor Detail

ShellLocation

public ShellLocation(String content,
                     Token token)

Constructor

Parameters:

content - the Shell script to highlight

token - a token to be pointed to (and certainly highlighted) in the Shell script

ShellLocation

public ShellLocation(String content,
                     int line,
                     int column,
                     int characterOffset)

Constructor

Parameters:

content - the Shell script to highlight

line - a line to point to (by convention, lines start at 1)

column - a column to point to (by convention, columns start at 1)

characterOffset - a character offset in the content equals to the number of characters read so far between the content's start and the given column of the given line

Method Detail

line

public int line()

Returns the line pointer remembered by this class

Returns:

the line pointer remembered by this class

column

public int column()

Returns the column pointer remembered by this class

Returns:

the column pointer remembered by this class

toString

public String toString()

Returns a string representation of this class

Overrides:

toString in class Object

Returns:

a string representation of this class

shift

public ShellLocation shift(int nbChar)

Returns a ShellLocation that corresponds to this instance + line, column and offset parameters moved forward of the passed number of characters

Parameters:

nbChar - a number of character to move forward

Returns:

a ShellLocation updated with the passed additional offset

Throws:

IllegalStateException - if the passed number of character added to the offset will point to a character beyond the content's end (i.e. if offset + nbChar > content.length())

See Also:

shift(char)

readChar

public char readChar()

Returns the character of the Shell script pointed to by the offset

Returns:

a character

isSameAs

public boolean isSameAs(ShellLocation other)

Tells if the passed ShellLocation has the same offset or not (this is a kind of shallow version of the equals method)

Parameters:

other - another ShellLocation

Returns:

true if the offset of the passed ShellLocation equals to the offset of this class, false if not