org.antlr.runtime.tree.ParseTree Class Reference

Inheritance diagram for org.antlr.runtime.tree.ParseTree:

Inheritance graph
[legend]
Collaboration diagram for org.antlr.runtime.tree.ParseTree:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 ParseTree (Object label)
Tree dupNode ()
int getType ()
String getText ()
int getTokenStartIndex ()
void setTokenStartIndex (int index)
int getTokenStopIndex ()
void setTokenStopIndex (int index)
String toString ()
String toStringWithHiddenTokens ()
String toInputString ()
void _toStringLeaves (StringBuffer buf)

Public Attributes

Object payload
List hiddenTokens


Detailed Description

A record of the rules used to match a token sequence. The tokens end up as the leaves of this tree and rule nodes are the interior nodes. This really adds no functionality, it is just an alias for CommonTree that is more meaningful (specific) and holds a String to display for a node.

Definition at line 39 of file ParseTree.java.


Constructor & Destructor Documentation

org.antlr.runtime.tree.ParseTree.ParseTree ( Object  label  ) 

Definition at line 43 of file ParseTree.java.


Member Function Documentation

Tree org.antlr.runtime.tree.ParseTree.dupNode (  ) 

Implements org.antlr.runtime.tree.Tree.

Definition at line 47 of file ParseTree.java.

int org.antlr.runtime.tree.ParseTree.getType (  ) 

Return a token type; needed for tree parsing

Implements org.antlr.runtime.tree.Tree.

Definition at line 51 of file ParseTree.java.

String org.antlr.runtime.tree.ParseTree.getText (  ) 

Implements org.antlr.runtime.tree.Tree.

Definition at line 55 of file ParseTree.java.

int org.antlr.runtime.tree.ParseTree.getTokenStartIndex (  ) 

What is the smallest token index (indexing from 0) for this node and its children?

Implements org.antlr.runtime.tree.Tree.

Definition at line 59 of file ParseTree.java.

void org.antlr.runtime.tree.ParseTree.setTokenStartIndex ( int  index  ) 

Implements org.antlr.runtime.tree.Tree.

Definition at line 63 of file ParseTree.java.

int org.antlr.runtime.tree.ParseTree.getTokenStopIndex (  ) 

What is the largest token index (indexing from 0) for this node and its children?

Implements org.antlr.runtime.tree.Tree.

Definition at line 66 of file ParseTree.java.

void org.antlr.runtime.tree.ParseTree.setTokenStopIndex ( int  index  ) 

Implements org.antlr.runtime.tree.Tree.

Definition at line 70 of file ParseTree.java.

String org.antlr.runtime.tree.ParseTree.toString (  )  [virtual]

Override to say how a node (not a tree) should look as text

Implements org.antlr.runtime.tree.BaseTree.

Definition at line 73 of file ParseTree.java.

String org.antlr.runtime.tree.ParseTree.toStringWithHiddenTokens (  ) 

Emit a token and all hidden nodes before. EOF node holds all hidden tokens after last real token.

Definition at line 87 of file ParseTree.java.

String org.antlr.runtime.tree.ParseTree.toInputString (  ) 

Print out the leaves of this tree, which means printing original input back out.

Definition at line 103 of file ParseTree.java.

void org.antlr.runtime.tree.ParseTree._toStringLeaves ( StringBuffer  buf  ) 

Definition at line 109 of file ParseTree.java.


Member Data Documentation

Definition at line 40 of file ParseTree.java.

Definition at line 41 of file ParseTree.java.


The documentation for this class was generated from the following file:

Generated on Wed Oct 1 14:13:47 2008 for ANTLR API by  doxygen 1.5.5