com.github.fge.grappa.matchers.wrap

Class VarFramingMatcher

java.lang.Object

com.github.fge.grappa.matchers.wrap.VarFramingMatcher

All Implemented Interfaces:

Matcher, GraphNode<Matcher>, Rule

public final class VarFramingMatcher
extends Object
implements Matcher

Special wrapping matcher that manages the creation and destruction of execution frames for a number of action vars.

Constructor Summary

Constructors

Constructor and Description
VarFramingMatcher(Rule inner, Var<?>[] variables)

Method Summary

Methods

Modifier and Type	Method and Description
List<Matcher>	getChildren() Returns the sub nodes of this node.
String	getLabel()
<V> MatcherContext<V>	getSubContext(MatcherContext<V> context) Creates a context for the matching of this matcher using the given parent context.
MatcherType	getType() Returns the type of this matcher
boolean	hasCustomLabel()
Rule	label(String label) Attaches a label to this Rule.
<V> boolean	match(MatcherContext<V> context) Tries a match on the given MatcherContext.
String	toString()
static Matcher	unwrap(Matcher matcher) Retrieves the innermost Matcher that is not a VarFramingMatcher.

Methods inherited from class java.lang.Object

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

Constructor Detail

VarFramingMatcher

public VarFramingMatcher(Rule inner,
                 Var<?>[] variables)

Method Detail

getType

public MatcherType getType()

Description copied from interface: Matcher

Returns the type of this matcher

Specified by:

getType in interface Matcher

Returns:

the type

See Also:

MatcherType

match

public <V> boolean match(MatcherContext<V> context)

Description copied from interface: Matcher

Tries a match on the given MatcherContext.

Specified by:

match in interface Matcher

Parameters:

context - the MatcherContext

Returns:

true if the match was successful

getChildren

public List<Matcher> getChildren()

Description copied from interface: GraphNode

Returns the sub nodes of this node.

Specified by:

getChildren in interface GraphNode<Matcher>

Returns:

the sub nodes

label

public Rule label(String label)

Description copied from interface: Rule

Attaches a label to this Rule. Corresponds to the @Label annotation.

Specified by:

label in interface Rule

Parameters:

label - the label

Returns:

this Rule

getLabel

public String getLabel()

Specified by:

getLabel in interface Matcher

Returns:

the label of the matcher (which is identical to the label of the Rule this matcher matches)

hasCustomLabel

public boolean hasCustomLabel()

Specified by:

hasCustomLabel in interface Matcher

Returns:

true if this matcher has been assigned a custom label

getSubContext

public <V> MatcherContext<V> getSubContext(MatcherContext<V> context)

Description copied from interface: Matcher

Creates a context for the matching of this matcher using the given parent context.

Specified by:

getSubContext in interface Matcher

Parameters:

context - the parent context

Returns:

the context this matcher is to be run in

toString

public String toString()

Overrides:

toString in class Object

unwrap

public static Matcher unwrap(Matcher matcher)

Retrieves the innermost Matcher that is not a VarFramingMatcher.

Parameters:

matcher - the matcher to unwrap

Returns:

the given instance if it is not a VarFramingMatcher, otherwise the innermost Matcher