eu.cqse.check.framework.scanner

Interface IToken

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ABAPToken, AdaToken, CobolToken, CPPToken, CSToken, DelphiToken, FortranToken, GosuToken, GoToken, GroovyToken, HanaSQLScriptToken, Iec61131Token, JavaDocToken, JavaScriptToken, JavaToken, JPLToken, KotlinToken, LineToken, MatlabToken, MTextToken, ObjectiveCToken, OCamlToken, OpenCLToken, OScriptToken, PHPToken, PL1Token, PLSQLToken, PythonToken, RubyToken, RustToken, SwiftToken, TextToken, Token, TSQLToken, VBToken, XMLToken, XtendToken

public interface IToken
extends java.io.Serializable

Object of type IToken are returned by the scanners. ITokens are immutable.

Method Summary

Modifier and Type	Method and Description
int	getEndOffset() Get the number of characters before the end of this token in the text (i.e.
ELanguage	getLanguage() Obtain language.
int	getLineNumber() Obtain number of line this token was found at.
int	getOffset() Get the number of characters before this token in the text.
java.lang.String	getOriginId() Get string that identifies the origin of this token.
java.lang.String	getText() Obtain the original input text for a token (copied verbatim from the source).
ETokenType	getType() Obtain type of token.
IToken	newToken(ETokenType type, int offset, int lineNumber, java.lang.String text, java.lang.String originId) Create new token.

Method Detail

getText

java.lang.String getText()

Obtain the original input text for a token (copied verbatim from the source).

getOffset

int getOffset()

Get the number of characters before this token in the text. The offset is 0-based and inclusive.

getEndOffset

int getEndOffset()

Get the number of characters before the end of this token in the text (i.e. the 0-based index of the last character, inclusive).

getLineNumber

int getLineNumber()

Obtain number of line this token was found at. Counting starts at 0. For tokens spanning multiple lines, this is the number of the line in which the first character of the token is.

getOriginId

java.lang.String getOriginId()

Get string that identifies the origin of this token. This can, e.g., be a uniform path to the resource. Its actual content depends on how the token gets constructed.

getType

ETokenType getType()

Obtain type of token.

getLanguage

ELanguage getLanguage()

Obtain language.

newToken

IToken newToken(ETokenType type,
                int offset,
                int lineNumber,
                java.lang.String text,
                java.lang.String originId)

Create new token. Can be used to clone or create modified copies of tokens.

Parameters:

type - Token type of new token

offset - Offset of new token

lineNumber - LineNumber of new token

text - Text of new token

originId - Origin id of new token

Returns:

New token with set values of the same java type as the token on which the method was called.