com.github.fge.grappa.matchers.base

Class AbstractMatcher

java.lang.Object

com.github.fge.grappa.misc.ImmutableGraphNode<Matcher>

com.github.fge.grappa.matchers.base.AbstractMatcher

All Implemented Interfaces:

Matcher, GraphNode<Matcher>, Rule, Cloneable

Direct Known Subclasses:

ActionMatcher, AnyMatcher, AnyOfMatcher, CaseInsensitiveTrieMatcher, CharIgnoreCaseMatcher, CharMatcher, CharRangeMatcher, CodePointMatcher, CodePointRangeMatcher, CustomDefaultLabelMatcher, EmptyMatcher, EndOfInputMatcher, NothingMatcher, RegexMatcher, RepeatMatcher, StringIgnoreCaseMatcher, StringMatcher, TrieMatcher

public abstract class AbstractMatcher
extends ImmutableGraphNode<Matcher>
implements Matcher, Cloneable

Abstract base class of most regular Matchers.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMatcher(Rule[] subRules, String label)
protected	AbstractMatcher(Rule subRule, String label)
protected	AbstractMatcher(String label)

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.
boolean	hasCustomLabel()
AbstractMatcher	label(String label) Attaches a label to this Rule.
String	toString()

Methods inherited from class com.github.fge.grappa.misc.ImmutableGraphNode

getChildren

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.fge.grappa.matchers.base.Matcher

getType, match

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

getChildren

Constructor Detail

AbstractMatcher

protected AbstractMatcher(String label)

AbstractMatcher

protected AbstractMatcher(Rule subRule,
               String label)

AbstractMatcher

protected AbstractMatcher(Rule[] subRules,
               String label)

Method Detail

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 final String toString()

Overrides:

toString in class Object

label

public final AbstractMatcher 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

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