ParseTree (ANTLR 4 Runtime 4.13.2 API)

All Superinterfaces:

SyntaxTree, Tree

All Known Subinterfaces:

ErrorNode, RuleNode, TerminalNode

All Known Implementing Classes:

ErrorNodeImpl, InterpreterRuleContext, ParserRuleContext, RuleContext, RuleContextWithAltNum, TerminalNodeImpl
```
public interface ParseTree
extends SyntaxTree
```
An interface to access the tree of RuleContext objects created during a parse that makes the data structure look like a simple parse tree. This node represents both internal nodes, rule invocations, and leaf nodes, token matches.
The payload is either a Token or a RuleContext object.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`<T> T`	`accept(ParseTreeVisitor<? extends T> visitor)`	The `ParseTreeVisitor` needs a double dispatch method.
`ParseTree`	`getChild(int i)`	If there are children, get the `i`th value indexed from 0.
`ParseTree`	`getParent()`	The parent of this node.
`String`	`getText()`	Return the combined text of all leaf nodes.
`void`	`setParent(RuleContext parent)`	Set the parent for this node.
`String`	`toStringTree(Parser parser)`	Specialize toStringTree so that it can print out more information based upon the parser.

Methods inherited from interface org.antlr.v4.runtime.tree.SyntaxTree
getSourceInterval

Methods inherited from interface org.antlr.v4.runtime.tree.Tree
getChildCount, getPayload, toStringTree

- Method Detail
  - getParent
```
ParseTree getParent()
```
    Description copied from interface: Tree
    
    The parent of this node. If the return value is null, then this node is the root of the tree.
    
    Specified by:
    
    getParent in interface Tree
  - getChild
```
ParseTree getChild(int i)
```
    Description copied from interface: Tree
    
    If there are children, get the ith value indexed from 0.
    
    Specified by:
    
    getChild in interface Tree
  - setParent
```
void setParent(RuleContext parent)
```
    Set the parent for this node. This is not backward compatible as it changes the interface but no one was able to create custom nodes anyway so I'm adding as it improves internal code quality. One could argue for a restructuring of the class/interface hierarchy so that setParent, addChild are moved up to Tree but that's a major change. So I'll do the minimal change, which is to add this method.
    
    Since:
    
    4.7
  - accept
```
<T> T accept(ParseTreeVisitor<? extends T> visitor)
```
    The ParseTreeVisitor needs a double dispatch method.
  - getText
```
String getText()
```
    Return the combined text of all leaf nodes. Does not get any off-channel tokens (if any) so won't return whitespace and comments if they are sent to parser on hidden channel.
  - toStringTree
```
String toStringTree(Parser parser)
```
    Specialize toStringTree so that it can print out more information based upon the parser.