eu.cqse.check.framework.scanner

Class Token

java.lang.Object

eu.cqse.check.framework.scanner.Token

All Implemented Interfaces:

IToken, java.io.Serializable

Direct Known Subclasses:

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, TSQLToken, VBToken, XMLToken, XtendToken

public abstract class Token
extends java.lang.Object
implements IToken

Base class for implementations of the token interface. This class is immutable.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	lineNumber Line number token was found at.
protected int	offset Number of characters before token in the resource it originates from
protected java.lang.String	originId Identifier of the resource this token originates from
protected java.lang.String	text Verbatim copy of the text found.
protected ETokenType	type Token type.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Token(ETokenType type, int offset, int lineNumber, java.lang.String text, java.lang.String originId) Constructor.

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.
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.
java.lang.String	toString() Obtain string representation of this token.

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.cqse.check.framework.scanner.IToken

getLanguage, newToken

Field Detail

type

protected final ETokenType type

Token type.

offset

protected final int offset

Number of characters before token in the resource it originates from

lineNumber

protected final int lineNumber

Line number token was found at.

text

protected final java.lang.String text

Verbatim copy of the text found.

originId

protected final java.lang.String originId

Identifier of the resource this token originates from

Constructor Detail

Token

protected Token(ETokenType type,
                int offset,
                int lineNumber,
                java.lang.String text,
                java.lang.String originId)

Constructor.

Method Detail

toString

public java.lang.String toString()

Obtain string representation of this token. This is meant for debugging purposes.

Overrides:

toString in class java.lang.Object

getText

public java.lang.String getText()

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

Specified by:

getText in interface IToken

getOffset

public int getOffset()

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

Specified by:

getOffset in interface IToken

getEndOffset

public 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).

Specified by:

getEndOffset in interface IToken

getLineNumber

public 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.

Specified by:

getLineNumber in interface IToken

getOriginId

public 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.

Specified by:

getOriginId in interface IToken

getType

public ETokenType getType()

Obtain type of token.

Specified by:

getType in interface IToken