Package jetbrains.mps.lang.pattern

Class NodeMatcher

java.lang.Object

jetbrains.mps.lang.pattern.NodeMatcher

public final class NodeMatcher
extends Object

Match/extract values of a node against pattern/sample node. Not thread-safe.

IMPLEMENTATION NODE: Pattern node passed to match(SNode, SNode) doesn't need to have set properties/association/aggregation we are going to capture/iterate with distinct matcher.

Since:

3.4

Constructor Summary

Constructors

Constructor	Description
NodeMatcher(ValueContainer vc)

Method Summary

Modifier and Type	Method	Description
NodeMatcher	any()	'wildcard' node match (aka '_')
NodeMatcher	association(SReferenceLink l, String linkVarName)
NodeMatcher	capture(String nodeVarName)
ChildMatcher	child(SContainmentLink role)
NodeMatcher	disjunct(SNode patternNode, NodeMatcher disjunct)	Tells to match disjunction of nodes using supplied alternatives.
ChildMatcher	done()
boolean	match(SNode pattern, SNode against)
NodeMatcher	property(SProperty p, String patternVarName)

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeMatcher

public NodeMatcher(@NotNull
                   ValueContainer vc)

Method Detail

property

public NodeMatcher property(@NotNull
                            SProperty p,
                            @NotNull
                            String patternVarName)

capture

public NodeMatcher capture(String nodeVarName)

any

public NodeMatcher any()

'wildcard' node match (aka '_')

Returns:

this

association

public NodeMatcher association(@NotNull
                               SReferenceLink l,
                               @NotNull
                               String linkVarName)

child

public ChildMatcher child(@NotNull
                          SContainmentLink role)

disjunct

public NodeMatcher disjunct(@NotNull
                            SNode patternNode,
                            @NotNull
                            NodeMatcher disjunct)

Tells to match disjunction of nodes using supplied alternatives. NodeMatcher with alternatives doesn't check children, associations or properties. It's still possible, though, to capture value of the node with capture(String).

When matching, each disjunct is processed in order they were added to the matcher, the first one to match cancels processing of other (i.e. similar to Java's || operator).

Parameters:

patternNode - pattern to match disjunct against.

disjunct - ordered matcher sequence, consulted one my one until match is found.

Returns:

this

done

public ChildMatcher done()

match

public boolean match(@NotNull
                     SNode pattern,
                     @NotNull
                     SNode against)