Top Description Methods
org.antlr.v4.runtime.tree

public Interface Tree

Known Direct Subinterfaces
org.antlr.v4.runtime.tree.SyntaxTree
Imports
org.antlr.v4.runtime.RuleContext, .Token
The basic notion of a tree has a parent, a payload, and a list of children. It is the most abstract interface for all the trees used by ANTLR.

Method Summary

Modifier and TypeMethod and Description
public Tree
getChild(int i)

If there are children, get the ith value indexed from 0.

public int
getChildCount()

How many children are there?

public Tree
getParent()

The parent of this node.

public Object
getPayload()

This method returns whatever object represents the data at this node.

public String
toStringTree()

Print out a whole tree, not just a node, in LISP format (root child1 ..

Method Detail

getChildback to summary
public Tree getChild(int i)

If there are children, get the ith value indexed from 0.

getChildCountback to summary
public int getChildCount()

How many children are there? If there is none, then this node represents a leaf node.

getParentback to summary
public Tree getParent()

The parent of this node. If the return value is null, then this node is the root of the tree.

getPayloadback to summary
public Object getPayload()

This method returns whatever object represents the data at this node. For example, for parse trees, the payload can be a Token representing a leaf node or a RuleContext object representing a rule invocation. For abstract syntax trees (ASTs), this is a Token object.

toStringTreeback to summary
public String toStringTree()

Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf.