com.github.fge.grappa.matchers.wrap

Class ProxyMatcher

java.lang.Object

com.github.fge.grappa.matchers.wrap.ProxyMatcher

All Implemented Interfaces:

Matcher, GraphNode<Matcher>, Rule, Cloneable

public final class ProxyMatcher
extends Object
implements Matcher, Cloneable

A Matcher that delegates all Rule and Matcher interface methods to another Matcher. It can also hold a label and a leaf marker and lazily apply these to the underlying Matcher once it is available.

Constructor Summary

Constructors

Constructor and Description
ProxyMatcher()

Method Summary

Methods

Modifier and Type	Method and Description
void	arm(Matcher target) Supplies this ProxyMatcher with its underlying delegate.
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.
void	setLabel(String label)
String	toString()
static Matcher	unwrap(Matcher matcher) Retrieves the innermost Matcher that is not a ProxyMatcher.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProxyMatcher

public ProxyMatcher()

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

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

setLabel

public void setLabel(String label)

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

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

toString

public String toString()

Overrides:

toString in class Object

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

arm

public void arm(Matcher target)

Supplies this ProxyMatcher with its underlying delegate.

Parameters:

target - the Matcher to delegate to

unwrap

public static Matcher unwrap(Matcher matcher)

Retrieves the innermost Matcher that is not a ProxyMatcher.

Parameters:

matcher - the matcher to unwrap

Returns:

the given instance if it is not a ProxyMatcher, otherwise the innermost non-proxy Matcher

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