Groovy Documentation

java.gate.yam.parse
Class Token

java.lang.Object
  java.gate.yam.parse.Token

class Token

Describes the input token stream.


Field Summary
int beginColumn

int beginLine

beginLine and beginColumn describe the position of the first character of this token; endLine and endColumn describe the position of the last character of this token.

int endColumn

int endLine

int endOffset

String image

The string image of the token.

int kind

An integer that describes the kind of this token.

Token next

A reference to the next regular (non-special) token from the input stream.

Token specialToken

This field is used to access special tokens that occur prior to this token, but after the immediately preceding regular (non-special) token.

int startOffset

The offsets of the token in absolute characters from the start of the document.

 
Constructor Summary
Token()

 
Method Summary
static Token newToken(int ofKind)

Returns a new Token object, by default.

static boolean samePlace(Token a, Token b)

Do two tokens point to the same place?

boolean samePlace(Token other)

Do two tokens point to the same place?

String toString()

Returns the image.

 
Methods inherited from class Object
wait, wait, wait, hashCode, getClass, equals, toString, notify, notifyAll
 

Field Detail

beginColumn

int beginColumn


beginLine

int beginLine
beginLine and beginColumn describe the position of the first character of this token; endLine and endColumn describe the position of the last character of this token.


endColumn

int endColumn


endLine

int endLine


endOffset

int endOffset


image

String image
The string image of the token.


kind

int kind
An integer that describes the kind of this token. This numbering system is determined by JavaCCParser, and a table of these numbers is stored in the file ...Constants.java.


next

Token next
A reference to the next regular (non-special) token from the input stream. If this is the last token from the input stream, or if the token manager has not read tokens beyond this one, this field is set to null. This is true only if this token is also a regular token. Otherwise, see below for a description of the contents of this field.


specialToken

Token specialToken
This field is used to access special tokens that occur prior to this token, but after the immediately preceding regular (non-special) token. If there are no such special tokens, this field is set to null. When there are more than one such special token, this field refers to the last of these special tokens, which in turn refers to the next previous special token through its specialToken field, and so on until the first special token (whose specialToken field is null). The next fields of special tokens refer to other special tokens that immediately follow it (without an intervening regular token). If there is no such token, this field is null.


startOffset

int startOffset
The offsets of the token in absolute characters from the start of the document. These are not set by default, but are used by the pretty-printing translator.


 
Constructor Detail

Token

Token()


 
Method Detail

newToken

public static final Token newToken(int ofKind)
Returns a new Token object, by default. However, if you want, you can create and return subclass objects based on the value of ofKind. Simply add the cases to the switch for all those special cases. For example, if you have a subclass of Token called IDToken that you want to create if ofKind is ID, simlpy add something like : case MyParserConstants.ID : return new IDToken(); to the following switch statement. Then you can cast matchedToken variable to the appropriate type and use it in your lexical actions.


samePlace

public static boolean samePlace(Token a, Token b)
Do two tokens point to the same place? (Two null values are considered to point to the same place.)


samePlace

public boolean samePlace(Token other)
Do two tokens point to the same place?


toString

public String toString()
Returns the image.


 

Groovy Documentation