org.antlr.runtime.tree

Class ParseTree

java.lang.Object

org.antlr.runtime.tree.BaseTree

org.antlr.runtime.tree.ParseTree

All Implemented Interfaces:

Tree

public class ParseTree
extends BaseTree

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.

Field Summary

Fields

Modifier and Type	Field and Description
List<Token>	hiddenTokens
Object	payload

Fields inherited from class org.antlr.runtime.tree.BaseTree

children

Fields inherited from interface org.antlr.runtime.tree.Tree

INVALID_NODE

Constructor Summary

Constructors

Constructor and Description
ParseTree(Object label)

Method Summary

Methods

Modifier and Type	Method and Description
void	_toStringLeaves(StringBuffer buf)
Tree	dupNode()
String	getText()
int	getTokenStartIndex() What is the smallest token index (indexing from 0) for this node and its children?
int	getTokenStopIndex() What is the largest token index (indexing from 0) for this node and its children?
int	getType() Return a token type; needed for tree parsing
void	setTokenStartIndex(int index)
void	setTokenStopIndex(int index)
String	toInputString() Print out the leaves of this tree, which means printing original input back out.
String	toString() Override to say how a node (not a tree) should look as text
String	toStringWithHiddenTokens() Emit a token and all hidden nodes before.

Methods inherited from class org.antlr.runtime.tree.BaseTree

addChild, addChildren, createChildrenList, deleteChild, freshenParentAndChildIndexes, freshenParentAndChildIndexes, freshenParentAndChildIndexesDeeply, freshenParentAndChildIndexesDeeply, getAncestor, getAncestors, getCharPositionInLine, getChild, getChildCount, getChildIndex, getChildren, getFirstChildWithType, getLine, getParent, hasAncestor, insertChild, isNil, replaceChildren, sanityCheckParentAndChildIndexes, sanityCheckParentAndChildIndexes, setChild, setChildIndex, setParent, toStringTree

Methods inherited from class java.lang.Object

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

Field Detail

payload

public Object payload

hiddenTokens

public List<Token> hiddenTokens

Constructor Detail

ParseTree

public ParseTree(Object label)

Method Detail

dupNode

public Tree dupNode()

getType

public int getType()

Description copied from interface: Tree

Return a token type; needed for tree parsing

getText

public String getText()

getTokenStartIndex

public int getTokenStartIndex()

Description copied from interface: Tree

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

setTokenStartIndex

public void setTokenStartIndex(int index)

getTokenStopIndex

public int getTokenStopIndex()

Description copied from interface: Tree

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

setTokenStopIndex

public void setTokenStopIndex(int index)

toString

public String toString()

Description copied from class: BaseTree

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

Specified by:

toString in interface Tree

Specified by:

toString in class BaseTree

toStringWithHiddenTokens

public String toStringWithHiddenTokens()

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

toInputString

public String toInputString()

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

_toStringLeaves

public void _toStringLeaves(StringBuffer buf)