com.massa.dsl.matcher

Interface LexerMatcher

All Superinterfaces:

Documented, MatcherAutoCompleter, Serializable

All Known Implementing Classes:

AbstractCombineLexerMatcher, AbstractLeafLexerMatcher, AbstractLexerMatcher, AbstractLexerMatcherWrapper, AndLexerMatcher, ChangeWeightLexerMatcher, DynamicLexerMatcher, EofMatcher, FixedLexerMatcher, LexerBlockMatcher, MultipleFixedLexerMatcher, NoopLexerMatcher, OrLexerMatcher, PropertyLexerMatcher, RegexLexerMatcher

public interface LexerMatcher
extends Documented, Serializable, MatcherAutoCompleter

Allows to match a part of a lexeme (start or end).

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LexerMatcher.Priority Describes the priority to apply to a matcher, in case two have the same weight.

Method Summary

Modifier and Type	Method and Description
Pattern	getFollowingCharPattern()
MatcherListener	getListener() Retrieves the MatcherListener if configured.
Matcher	getMatcher(LexerParser parser)
AutoCompleteConfiguration	getMatcherAutoCompleteConfiguration() Allows to configure a preferred autoComplete scheme for this lexer matcher.
Pattern	getPreviousCharPattern()
LexerMatcher.Priority	getPriority() Default priority should be the "normal" value.
boolean	isExclusionHierarchyBreaker() Tells if this matcher should break search for exclusion in older hierarchy.
boolean	isSkipMatchText()
boolean	isSkipSpacesBeforeMatch() In general, should be true, because spaces are unused characters.

Methods inherited from interface com.massa.dsl.doc.Documented

getDslDoc, setDslDoc

Methods inherited from interface com.massa.dsl.autocomplete.MatcherAutoCompleter

setMatcherAutoCompleteConfiguration

Method Detail

getMatcher

Matcher getMatcher(LexerParser parser)
            throws DslException

Returns:

Matcher instance for the provided Lexer Parser.

Throws:

DslException

getPreviousCharPattern

Pattern getPreviousCharPattern()

Returns:

Regex Pattern to which the previous character must match, or null if unspecified.

getFollowingCharPattern

Pattern getFollowingCharPattern()

Returns:

Regex Pattern to which the following character must match, or null if unspecified.

isSkipMatchText

boolean isSkipMatchText()

Returns:

true if matched text must be skipped or unread to be provided to the parser.

isSkipSpacesBeforeMatch

boolean isSkipSpacesBeforeMatch()

In general, should be true, because spaces are unused characters. Should only be forced to false in case of spaces must be taken into account.

Returns:

true if spaces must be skiped before starting matching process..

isExclusionHierarchyBreaker

boolean isExclusionHierarchyBreaker()

Tells if this matcher should break search for exclusion in older hierarchy.
Typically, the AndLexerMatcher is concerned.

getPriority

LexerMatcher.Priority getPriority()

Default priority should be the "normal" value.

Returns:

a priority which is used if the engine can't differentiate two lexers by their weight.

getMatcherAutoCompleteConfiguration

AutoCompleteConfiguration getMatcherAutoCompleteConfiguration()

Allows to configure a preferred autoComplete scheme for this lexer matcher.
Allows to disable all automatic options for this lexer matcher, but not for other lexer matchers.

Specified by:

getMatcherAutoCompleteConfiguration in interface MatcherAutoCompleter

Returns:

AutoComplete configuration.

getListener

MatcherListener getListener()

Retrieves the MatcherListener if configured.