com.massa.dsl.lexer

Class AbstractLexer

java.lang.Object

com.massa.dsl.lexer.AbstractLexer

All Implemented Interfaces:

MatcherAutoCompleter, Documented, Lexer, Serializable

Direct Known Subclasses:

BooleanLexer, CharacterLexer, EnumLexer, HardCodedLexer, IntegerLexer, MatcherLexer, NextCharLexer, NextSpaceLexer, NullLexer, ObjectLexer, RegexLexer, StringLexer, SubParseLexer, TextLexer, TransformLexer, ValueLexer, ValuesLexer

public abstract class AbstractLexer
extends Object
implements Lexer

Base class for all Lexer implementations

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractLexer()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
DslDoc	getDslDoc() Extra documentation used by doc gen.
LexerMatcher	getEnd()
String	getId()
LexerParserListener	getListener() Retrieves the LexerParserListener if configured.
Class<? extends LexerParserListener>	getListenerClass()
AutoCompleteConfiguration	getMatcherAutoCompleteConfiguration() Allows to configure a preferred autoComplete scheme for this lexer.
LexerMatcher	getStart()
int	hashCode()
boolean	isRoot()
boolean	isRootOnly()
LexerMatcher	resolveEnd(LexerParser lexerParser) Resolves the end matcher for this lexer.
LexerMatcher	resolveStart(LexerParser lexerParser) Resolves the start matcher for this lexer.
void	setDslDoc(DslDoc dslDoc) Extra documentation used by doc gen.
void	setEnd(LexerMatcher end)
void	setId(String id)
void	setListenerClass(Class<? extends LexerParserListener> listenerClass) Also sets internal instance.
void	setMatcherAutoCompleteConfiguration(AutoCompleteConfiguration autoCompleteConfiguration) Allows to configure a preferred autoComplete scheme.
void	setRoot(boolean root)
void	setRootOnly(boolean rootOnly)
void	setStart(LexerMatcher start)
String	toString()
void	validate(Grammar grammar) Default implementation does nothing.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.massa.dsl.lexer.Lexer

getParser, isOrdered, resolveType

Constructor Detail

AbstractLexer

public AbstractLexer()

Method Detail

getId

public String getId()

Specified by:

getId in interface Lexer

Returns:

Lexer unique ID

setId

public void setId(String id)

Specified by:

setId in interface Lexer

Parameters:

id - Lexer unique ID to set

isRoot

public boolean isRoot()

Specified by:

isRoot in interface Lexer

Returns:

true if this lexer can be used as root, i.e. at first parsing level

setRoot

public void setRoot(boolean root)

isRootOnly

public boolean isRootOnly()

Specified by:

isRootOnly in interface Lexer

Returns:

true if this lexer can be used only as root, i.e. at first parsing level

setRootOnly

public void setRootOnly(boolean rootOnly)

resolveStart

public LexerMatcher resolveStart(LexerParser lexerParser)
                          throws DslException

Description copied from interface: Lexer

Resolves the start matcher for this lexer. This method should be used mainly by the LexerParser to retrieve its matcher instance.

Specified by:

resolveStart in interface Lexer

Throws:

DslException

See Also:

LexerParser.resolveStart()

getStart

public LexerMatcher getStart()

setStart

public void setStart(LexerMatcher start)

getEnd

public LexerMatcher getEnd()

resolveEnd

public LexerMatcher resolveEnd(LexerParser lexerParser)
                        throws DslException

Description copied from interface: Lexer

Resolves the end matcher for this lexer. This method should be used mainly by the LexerParser to retrieve its matcher instance.

Specified by:

resolveEnd in interface Lexer

Throws:

DslException

See Also:

LexerParser.resolveEnd()

setEnd

public void setEnd(LexerMatcher end)

getListenerClass

public Class<? extends LexerParserListener> getListenerClass()

setListenerClass

public void setListenerClass(Class<? extends LexerParserListener> listenerClass)
                      throws UtilsException

Also sets internal instance.

Throws:

UtilsException

getListener

public LexerParserListener getListener()

Description copied from interface: Lexer

Retrieves the LexerParserListener if configured.

Specified by:

getListener in interface Lexer

getMatcherAutoCompleteConfiguration

public AutoCompleteConfiguration getMatcherAutoCompleteConfiguration()

Description copied from interface: Lexer

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

Specified by:

getMatcherAutoCompleteConfiguration in interface MatcherAutoCompleter

Specified by:

getMatcherAutoCompleteConfiguration in interface Lexer

Returns:

AutoComplete configuration.

setMatcherAutoCompleteConfiguration

public void setMatcherAutoCompleteConfiguration(AutoCompleteConfiguration autoCompleteConfiguration)

Description copied from interface: MatcherAutoCompleter

Allows to configure a preferred autoComplete scheme.

Specified by:

setMatcherAutoCompleteConfiguration in interface MatcherAutoCompleter

getDslDoc

public DslDoc getDslDoc()

Description copied from interface: Documented

Extra documentation used by doc gen.

Specified by:

getDslDoc in interface Documented

setDslDoc

public void setDslDoc(DslDoc dslDoc)

Description copied from interface: Documented

Extra documentation used by doc gen.

Specified by:

setDslDoc in interface Documented

validate

public void validate(Grammar grammar)
              throws DslException

Default implementation does nothing.

Specified by:

validate in interface Lexer

Parameters:

grammar - Related grammar

Throws:

DslException

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object