com.github.sbaudoin.sonar.plugins.shellcheck.lexer

Class Token

java.lang.Object

com.github.sbaudoin.sonar.plugins.shellcheck.lexer.Token

All Implemented Interfaces:

Serializable, Comparable

public class Token
extends Object
implements Serializable, Comparable

This class represents the tokens identified by Shell lexers

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	column The column at which the token starts in the line (starting from 0)
int	length The length of the token (in characters)
int	line The line number at which the token starts (starting from 0)
int	start The offset (in characters) at which the token was identified in the source Shell code
TokenType	type The token type

Constructor Summary

Constructors

Constructor and Description
Token(TokenType type, int start, int length, int line, int column) Constructs a new token

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object o)
int	end() return the end position of the token
boolean	equals(Object obj)
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

type

public final TokenType type

The token type

start

public final int start

The offset (in characters) at which the token was identified in the source Shell code

length

public final int length

The length of the token (in characters)

line

public final int line

The line number at which the token starts (starting from 0)

column

public final int column

The column at which the token starts in the line (starting from 0)

Constructor Detail

Token

public Token(TokenType type,
             int start,
             int length,
             int line,
             int column)

Constructs a new token

Parameters:

start - the offset (in characters) at which the token starts

type - the token type

column - the column (in characters, starting from 0) where the token starts on the line

length - the token's length

line - the line number (starting from 0) where the token was found

See Also:

TokenType

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(Object o)

Specified by:

compareTo in interface Comparable

end

public int end()

return the end position of the token

Returns:

start + length