es.litesolutions.sonar.grappa

Class GrappaSslrFactory.Builder<P extends SonarParserBase>

java.lang.Object

es.litesolutions.sonar.grappa.GrappaSslrFactory.Builder<P>

Type Parameters:

P - the type of the parser used

Enclosing class:

GrappaSslrFactory

public static final class GrappaSslrFactory.Builder<P extends SonarParserBase>
extends java.lang.Object

A builder for a GrappaSslrFactory

This class is not directly instantiable; use GrappaSslrFactory.withParserClass(Class) to create a new instance.

Method Summary

Modifier and Type	Method and Description
GrappaSslrFactory.Builder<P>	addListenerSupplier(ListenerSupplier supplier) Add a ListenerSupplier to the factory Since a ListeningParseRunner is used, it means you can add further parsing listeners when the file is parsed; for instance, you may want to add a TracingListener to debug the parsing process.
GrappaSslrFactory	build() Build the factory
GrappaSslrFactory.Builder<P>	withEntryPoint(org.sonar.sslr.grammar.GrammarRuleKey entryPoint) Define the grammar entry point for the grammar
GrappaSslrFactory.Builder<P>	withGrammarClass(java.lang.Class<? extends org.sonar.sslr.grammar.GrammarRuleKey> grammarClass) Deprecated. use withGrammarInjector(GrammarInjector) instead
GrappaSslrFactory.Builder<P>	withGrammarInjector(GrammarInjector injector) Sets the grammar injector for this factory Since Java 8 is used, and a GrammarInjector is a functional interface, you can use method references here.
GrappaSslrFactory.Builder<P>	withMainRule(java.util.function.Function<P,com.github.fge.grappa.rules.Rule> ruleFunction) Define the main rule for the parser as a Function Typically, if your parser class is MyParser and the rule you want as a main rule is called myRule, the argument to this method will be MyParser::myRule.

Methods inherited from class java.lang.Object

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

Method Detail

withGrammarClass

@Deprecated
public GrappaSslrFactory.Builder<P> withGrammarClass(java.lang.Class<? extends org.sonar.sslr.grammar.GrammarRuleKey> grammarClass)

Deprecated. use withGrammarInjector(GrammarInjector) instead

Set the grammar for the factory

The grammar class, in this case, is expected to have a static method named injectInto which takes a LexerfulGrammarBuilder as its sole argument.

Parameters:

grammarClass - the class

Returns:

this

withGrammarInjector

public GrappaSslrFactory.Builder<P> withGrammarInjector(GrammarInjector injector)

Sets the grammar injector for this factory

Since Java 8 is used, and a GrammarInjector is a functional interface, you can use method references here.

Parameters:

injector - the injector

Returns:

this

withEntryPoint

public GrappaSslrFactory.Builder<P> withEntryPoint(org.sonar.sslr.grammar.GrammarRuleKey entryPoint)

Define the grammar entry point for the grammar

Parameters:

entryPoint - the entry point, as a GrammarRuleKey

Returns:

this

See Also:

LexerfulGrammarBuilder.setRootRule(GrammarRuleKey)

withMainRule

public GrappaSslrFactory.Builder<P> withMainRule(java.util.function.Function<P,com.github.fge.grappa.rules.Rule> ruleFunction)

Define the main rule for the parser as a Function

Typically, if your parser class is MyParser and the rule you want as a main rule is called myRule, the argument to this method will be MyParser::myRule.

Parameters:

ruleFunction - the function providing the rule

Returns:

this

addListenerSupplier

public GrappaSslrFactory.Builder<P> addListenerSupplier(ListenerSupplier supplier)

Add a ListenerSupplier to the factory

Since a ListeningParseRunner is used, it means you can add further parsing listeners when the file is parsed; for instance, you may want to add a TracingListener to debug the parsing process.

Parameters:

supplier - the supplier

Returns:

this

build

public GrappaSslrFactory build()

Build the factory

Returns:

the factory