org.ejen.ext.parsers.java_1_2
Class Token

java.lang.Object
  |
  +--org.ejen.ext.parsers.java_1_2.Token

public class Token

extends Object

Modification of the Token class generated by JavaCC.

Version:

1.0

Author:

F. Wolff

Field Summary

int	beginColumn 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	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 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	endLine 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.
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.

Constructor Summary

Token()

Method Summary

static Token	newToken(int ofKind) Returns a new Token object, by default.
void	toNode(Document doc, Node parent, int[] tokensMap, boolean tokensPos) Creates a child DOM node appended to the 'parent' node, depending on the 'tokensMap' parameter.
protected void	toSpecialNode(Document doc, Node parent, int[] tokensMap, boolean tokensPos) Creates a child 'stok' DOM node allways appended to a 'tok' parent node, depending on the 'tokensMap' parameter.
String	toString() Returns the image.

Methods inherited from class java.lang.Object

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

Field Detail

kind

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

beginLine

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

beginColumn

public int beginColumn

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.

endLine

public int endLine

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

public int endColumn

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.

image

public String image

The string image of the token.

next

public 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

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

Constructor Detail

Token

public Token()

Method Detail

toString

public final String toString()

Returns the image.

Overrides:

toString in class Object

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.

toNode

public final void toNode(Document doc,
                         Node parent,
                         int[] tokensMap,
                         boolean tokensPos)
                  throws DOMException

Creates a child DOM node appended to the 'parent' node, depending on the 'tokensMap' parameter. The child node will have the following structure:

  <tok ki="72"><![CDATA[ejen]]></tok>

  or, if tokensPos is true,

  <tok bc="13" bl="22" ec="16" el="22" ki="72">
    <![CDATA[ejen]]>
  </tok>
 

meaning that the token "ejen" of kind 72 (JavaParserConstants.IDENTIFIER) begins in the source file at the (22,13) line,column coordinates and ends at the (22,16) coordinates. Token nodes may also have nested special token nodes.

See also ArlUtil.

Parameters:

doc - the Document in which the nodes are to be created.

parent - the DOM node to which the new Node must be appended.

tokensMap - an int array specifying, for each Token kind, if this node must accepted (created), crossed (only the CDATA section is created without a parent <tok...> node creation) or removed (no node creation, no CDATA section).

tokensPos - if true, this Token position coordinates will be includes as attributes.

Throws:

DOMException - DOM errors...

toSpecialNode

protected final void toSpecialNode(Document doc,
                                   Node parent,
                                   int[] tokensMap,
                                   boolean tokensPos)
                            throws DOMException

Creates a child 'stok' DOM node allways appended to a 'tok' parent node, depending on the 'tokensMap' parameter. The child node will have the following structure:

  <stok ki="10"><![CDATA[/** Javadoc comment */]]></stok>

  or, if tokensPos is true,

  <stok bc="13" bl="22" ec="16" el="22" ki="10">
    <![CDATA[/** Javadoc comment */]]>
  </stok>
 

meaning that the special token of kind 10 (JavaParserConstants.FORMAL_COMMENT) begins in the source file at the (22,13) line,column coordinates and ends at the (22,16) coordinates and contains the String "/** Javadoc comment */".

See also ArlUtil.

Parameters:

doc - the Document in which the nodes are to be created.

parent - the DOM node to which the new Node must be appended.

tokensMap - an int array specifying, for each Token kind, if this node must accepted (created), crossed (only the CDATA section is created without a parent <tok...> node creation) or removed (no node creation, no CDATA section).

tokensPos - if true, this Token position coordinates will be includes as attributes.

Throws:

DOMException - DOM errors...