Package org.antlr.v4.runtime.tree.pattern

Class ParseTreePattern

java.lang.Object

org.antlr.v4.runtime.tree.pattern.ParseTreePattern

public class ParseTreePattern
extends Object

A pattern like <ID> = <expr>; converted to a ParseTree by ParseTreePatternMatcher.compile(String, int).

Field Summary

Fields

Modifier and Type	Field	Description
private final ParseTreePatternMatcher	matcher	This is the backing field for getMatcher().
private final String	pattern	This is the backing field for getPattern().
private final int	patternRuleIndex	This is the backing field for getPatternRuleIndex().
private final ParseTree	patternTree	This is the backing field for getPatternTree().

Constructor Summary

Constructors

Constructor	Description
ParseTreePattern(ParseTreePatternMatcher matcher, String pattern, int patternRuleIndex, ParseTree patternTree)	Construct a new instance of the ParseTreePattern class.

Method Summary

Modifier and Type	Method	Description
List<ParseTreeMatch>	findAll(ParseTree tree, String xpath)	Find all nodes using XPath and then try to match those subtrees against this tree pattern.
ParseTreePatternMatcher	getMatcher()	Get the ParseTreePatternMatcher which created this tree pattern.
String	getPattern()	Get the tree pattern in concrete syntax form.
int	getPatternRuleIndex()	Get the parser rule which serves as the outermost rule for the tree pattern.
ParseTree	getPatternTree()	Get the tree pattern as a ParseTree.
ParseTreeMatch	match(ParseTree tree)	Match a specific parse tree against this tree pattern.
boolean	matches(ParseTree tree)	Determine whether or not a parse tree matches this tree pattern.

Methods inherited from class java.lang.Object

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

Field Details

patternRuleIndex

private final int patternRuleIndex

This is the backing field for getPatternRuleIndex().

pattern

@NotNull
private final String pattern

This is the backing field for getPattern().

patternTree

@NotNull
private final ParseTree patternTree

This is the backing field for getPatternTree().

matcher

@NotNull
private final ParseTreePatternMatcher matcher

This is the backing field for getMatcher().

Constructor Details

ParseTreePattern

public ParseTreePattern(@NotNull
 ParseTreePatternMatcher matcher,
 @NotNull
 String pattern,
 int patternRuleIndex,
 @NotNull
 ParseTree patternTree)

Construct a new instance of the ParseTreePattern class.

Parameters:

matcher - The ParseTreePatternMatcher which created this tree pattern.

pattern - The tree pattern in concrete syntax form.

patternRuleIndex - The parser rule which serves as the root of the tree pattern.

patternTree - The tree pattern in ParseTree form.

Method Details

match

@NotNull
public ParseTreeMatch match(@NotNull
 ParseTree tree)

Match a specific parse tree against this tree pattern.

Parameters:

tree - The parse tree to match against this tree pattern.

Returns:

A ParseTreeMatch object describing the result of the match operation. The ParseTreeMatch.succeeded() method can be used to determine whether or not the match was successful.

matches

public boolean matches(@NotNull
 ParseTree tree)

Determine whether or not a parse tree matches this tree pattern.

Parameters:

tree - The parse tree to match against this tree pattern.

Returns:

true if tree is a match for the current tree pattern; otherwise, false.

findAll

@NotNull
public List<ParseTreeMatch> findAll(@NotNull
 ParseTree tree,
 @NotNull
 String xpath)

Find all nodes using XPath and then try to match those subtrees against this tree pattern.

Parameters:

tree - The ParseTree to match against this pattern.

xpath - An expression matching the nodes

Returns:

A collection of ParseTreeMatch objects describing the successful matches. Unsuccessful matches are omitted from the result, regardless of the reason for the failure.

getMatcher

@NotNull
public ParseTreePatternMatcher getMatcher()

Get the ParseTreePatternMatcher which created this tree pattern.

Returns:

The ParseTreePatternMatcher which created this tree pattern.

getPattern

@NotNull
public String getPattern()

Get the tree pattern in concrete syntax form.

Returns:

The tree pattern in concrete syntax form.

getPatternRuleIndex

public int getPatternRuleIndex()

Get the parser rule which serves as the outermost rule for the tree pattern.

Returns:

The parser rule which serves as the outermost rule for the tree pattern.

getPatternTree

@NotNull
public ParseTree getPatternTree()

Get the tree pattern as a ParseTree. The rule and token tags from the pattern are present in the parse tree as terminal nodes with a symbol of type RuleTagToken or TokenTagToken.

Returns:

The tree pattern as a ParseTree.