com.github.fge.grappa.matchers.base

Interface Matcher

All Superinterfaces:

GraphNode<Matcher>, Rule

All Known Implementing Classes:

AbstractMatcher, ActionMatcher, AnyMatcher, AnyOfMatcher, BoundedBothJoinMatcher, BoundedBothRepeatMatcher, BoundedDownJoinMatcher, BoundedDownRepeatMatcher, BoundedUpJoinMatcher, BoundedUpRepeatMatcher, CaseInsensitiveTrieMatcher, CharIgnoreCaseMatcher, CharMatcher, CharRangeMatcher, CodePointMatcher, CodePointRangeMatcher, CustomDefaultLabelMatcher, EmptyMatcher, EndOfInputMatcher, ExactMatchesJoinMatcher, ExactMatchesRepeatMatcher, FirstOfMatcher, JoinMatcher, NothingMatcher, OptionalMatcher, ProxyMatcher, RegexMatcher, RepeatMatcher, SequenceMatcher, StringIgnoreCaseMatcher, StringMatcher, TestMatcher, TestNotMatcher, TrieMatcher, VarFramingMatcher

public interface Matcher
extends Rule, GraphNode<Matcher>

A Matcher instance is responsible for "executing" a specific Rule instance, i.e. it implements the actual rule type specific matching logic. Since it extends the GraphNode interface it can have submatchers.

Method Summary

Methods

Modifier and Type	Method and Description
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()
<V> boolean	match(MatcherContext<V> context) Tries a match on the given MatcherContext.

Methods inherited from interface com.github.fge.grappa.rules.Rule

label

Methods inherited from interface com.github.fge.grappa.misc.GraphNode

getChildren

Method Detail

getType

MatcherType getType()

Returns the type of this matcher

Returns:

the type

See Also:

MatcherType

getLabel

String getLabel()

Returns:

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

hasCustomLabel

boolean hasCustomLabel()

Returns:

true if this matcher has been assigned a custom label

getSubContext

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

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

Parameters:

context - the parent context

Returns:

the context this matcher is to be run in

match

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

Tries a match on the given MatcherContext.

Parameters:

context - the MatcherContext

Returns:

true if the match was successful