ANTLR 4 Runtime 4.13.1 · org.antlr.v4.runtime.tree.pattern.ParseTreePattern

Field Summary

Modifier and Type	Field and 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

Access	Constructor and Description
public	ParseTreePattern(ParseTreePatternMatcher The `ParseTreePatternMatcher` which created this tree pattern. matcher, String The tree pattern in concrete syntax form. pattern, int The parser rule which serves as the root of the tree pattern. patternRuleIndex, ParseTree The tree pattern in `ParseTree` form. patternTree) Construct a new instance of the `ParseTreePattern` class.

Method Summary

Modifier and Type	Method and Description
public List<ParseTreeMatch>	Returns: A collection of `ParseTreeMatch` objects describing the successful matches. Unsuccessful matches are omitted from the result, regardless of the reason for the failure. findAll(ParseTree The `ParseTree` to match against this pattern. tree, String An expression matching the nodes xpath) Find all nodes using XPath and then try to match those subtrees against this tree pattern.
public ParseTreePatternMatcher	Returns: The `ParseTreePatternMatcher` which created this tree pattern. getMatcher() Get the `ParseTreePatternMatcher` which created this tree pattern.
public String	Returns: The tree pattern in concrete syntax form. getPattern() Get the tree pattern in concrete syntax form.
public int	Returns: The parser rule which serves as the outermost rule for the tree pattern. getPatternRuleIndex() Get the parser rule which serves as the outermost rule for the tree pattern.
public ParseTree	Returns: The tree pattern as a `ParseTree`. getPatternTree() Get the tree pattern as a `ParseTree`.
public ParseTreeMatch	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. match(ParseTree The parse tree to match against this tree pattern. tree) Match a specific parse tree against this tree pattern.
public boolean	Returns: `true` if `tree` is a match for the current tree pattern; otherwise, `false`. matches(ParseTree The parse tree to match against this tree pattern. tree) Determine whether or not a parse tree matches this tree pattern.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

matcher	back to summary
private final ParseTreePatternMatcher matcher This is the backing field for `getMatcher()`.

pattern	back to summary
private final String pattern This is the backing field for `getPattern()`.

patternRuleIndex	back to summary
private final int patternRuleIndex This is the backing field for `getPatternRuleIndex()`.

patternTree	back to summary
private final ParseTree patternTree This is the backing field for `getPatternTree()`.

Constructor Detail

ParseTreePattern back to summary

ParseTreePattern	back to summary
public ParseTreePattern(ParseTreePatternMatcher matcher, String pattern, int patternRuleIndex, ParseTree patternTree) Construct a new instance of the `ParseTreePattern` class. Parameters matcher:ParseTreePatternMatcher The `ParseTreePatternMatcher` which created this tree pattern. pattern:String The tree pattern in concrete syntax form. patternRuleIndex:int The parser rule which serves as the root of the tree pattern. patternTree:ParseTree The tree pattern in `ParseTree` form.

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

Construct a new instance of the ParseTreePattern class.

Parameters

matcher:ParseTreePatternMatcher: The ParseTreePatternMatcher which created this tree pattern.
pattern:String: The tree pattern in concrete syntax form.
patternRuleIndex:int: The parser rule which serves as the root of the tree pattern.
patternTree:ParseTree: The tree pattern in ParseTree form.

Method Detail

findAll back to summary

findAll	back to summary
public List<ParseTreeMatch> findAll(ParseTree tree, String xpath) Find all nodes using XPath and then try to match those subtrees against this tree pattern. Parameters tree:ParseTree The `ParseTree` to match against this pattern. xpath:String An expression matching the nodes Returns:List<ParseTreeMatch> A collection of `ParseTreeMatch` objects describing the successful matches. Unsuccessful matches are omitted from the result, regardless of the reason for the failure.

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

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

Parameters

tree:ParseTree: The ParseTree to match against this pattern.
xpath:String: An expression matching the nodes

Returns:List<ParseTreeMatch>

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

getMatcher back to summary

getMatcher	back to summary
public ParseTreePatternMatcher getMatcher() Get the `ParseTreePatternMatcher` which created this tree pattern. Returns:ParseTreePatternMatcher The `ParseTreePatternMatcher` which created this tree pattern.

public ParseTreePatternMatcher getMatcher()

Get the ParseTreePatternMatcher which created this tree pattern.

Returns:ParseTreePatternMatcher: The ParseTreePatternMatcher which created this tree pattern.

getPattern	back to summary
public String getPattern() Get the tree pattern in concrete syntax form. Returns:String The tree pattern in concrete syntax form.

getPattern

back to summary

public String getPattern()

Get the tree pattern in concrete syntax form.

Returns:String: The tree pattern in concrete syntax form.

getPatternRuleIndex	back to summary
public int getPatternRuleIndex() Get the parser rule which serves as the outermost rule for the tree pattern. Returns:int The parser rule which serves as the outermost rule for the tree pattern.

getPatternRuleIndex

back to summary

public int getPatternRuleIndex()

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

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

getPatternTree back to summary

getPatternTree	back to summary
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:ParseTree The tree pattern as a `ParseTree`.

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:ParseTree: The tree pattern as a ParseTree.

match back to summary

match	back to summary
public ParseTreeMatch match(ParseTree tree) Match a specific parse tree against this tree pattern. Parameters tree:ParseTree The parse tree to match against this tree pattern. Returns:ParseTreeMatch 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.

public ParseTreeMatch match(ParseTree tree)

Match a specific parse tree against this tree pattern.

Parameters

tree:ParseTree: The parse tree to match against this tree pattern.

Returns:ParseTreeMatch

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 back to summary

matches	back to summary
public boolean matches(ParseTree tree) Determine whether or not a parse tree matches this tree pattern. Parameters tree:ParseTree The parse tree to match against this tree pattern. Returns:boolean `true` if `tree` is a match for the current tree pattern; otherwise, `false`.

public boolean matches(ParseTree tree)

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

Parameters

tree:ParseTree: The parse tree to match against this tree pattern.

Returns:boolean

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

public Class ParseTreePattern

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail