com.massa.dsl.grammar

Class Grammar

java.lang.Object

com.massa.dsl.grammar.Grammar

All Implemented Interfaces:

Documented, Serializable

public class Grammar
extends Object
implements Documented, Serializable

Java representation of the grammar, entry point to parse code file.
The grammar object is thread safe when build is finished and several sources can be parsed in parallel.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Grammar()

Method Summary

Modifier and Type	Method and Description
void	addLexer(Lexer lexer) Adds new lexer to internal repository
Set<ParsingContext.AutoCompleteResult>	autoComplete(AdvancedReader source) Launches a partial parsing process of a source stream, stopping at the end of the source stream and returning computed possibilities for the following text.
AdditionalGrammarValidator	getAdditionalValidator()
String	getCommentBegin()
DslDoc	getDslDoc() Extra documentation used by doc gen.
String	getId()
Lexer	getLexerFromId(String lexerId) Queries internal lexer repository by unique id.
List<Lexer>	getLexerFromType(Class<?> lexerType, Set<String> excludedIds, Set<Class<?>> excludedTypes) Queries internal lexer repository by lexer returning type (i.e. the parsing result type).
String	getLocale()
ObjectCreator	getObjectCreator()
Object	parse(AdvancedReader source) Launches the full parsing process of a source stream.
void	setAdditionalValidator(AdditionalGrammarValidator additionalValidator)
void	setCommentBegin(String commentBegin)
void	setDslDoc(DslDoc dslDoc) Extra documentation used by doc gen.
void	setId(String id)
void	setLocale(String locale)
void	setObjectCreator(ObjectCreator objectCreator)
void	validate() Allows to validate the grammar.
void	validate(AdvancedReader source) Validates the syntax of the source.

Methods inherited from class java.lang.Object

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

Constructor Detail

Grammar

public Grammar()

Method Detail

addLexer

public void addLexer(Lexer lexer)
              throws DslException

Adds new lexer to internal repository

Throws:

DslException

getLexerFromId

public Lexer getLexerFromId(String lexerId)

Queries internal lexer repository by unique id.

getLexerFromType

public List<Lexer> getLexerFromType(Class<?> lexerType,
                                    Set<String> excludedIds,
                                    Set<Class<?>> excludedTypes)
                             throws DslException

Queries internal lexer repository by lexer returning type (i.e. the parsing result type).

Throws:

DslException

parse

public Object parse(AdvancedReader source)
             throws DslException

Launches the full parsing process of a source stream.

Throws:

DslException

validate

public void validate(AdvancedReader source)
              throws DslException

Validates the syntax of the source.
If invalid, a DslException will be thrown.

Throws:

DslException

autoComplete

public Set<ParsingContext.AutoCompleteResult> autoComplete(AdvancedReader source)
                                                    throws DslException

Launches a partial parsing process of a source stream, stopping at the end of the source stream and returning computed possibilities for the following text.
The method AdvancedReader.setMaxReadLen(int) can be used to set the autoComplete point in the middle of the text content.

Throws:

DslException

validate

public void validate()
              throws DslException

Allows to validate the grammar.

Throws:

DslException

getCommentBegin

public String getCommentBegin()

setCommentBegin

public void setCommentBegin(String commentBegin)

getObjectCreator

public ObjectCreator getObjectCreator()

setObjectCreator

public void setObjectCreator(ObjectCreator objectCreator)

getAdditionalValidator

public AdditionalGrammarValidator getAdditionalValidator()

setAdditionalValidator

public void setAdditionalValidator(AdditionalGrammarValidator additionalValidator)

getId

public String getId()

setId

public void setId(String id)

getLocale

public String getLocale()

setLocale

public void setLocale(String locale)

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