es.litesolutions.sonar.grappa

Class GrappaSslrFactory

java.lang.Object

es.litesolutions.sonar.grappa.GrappaSslrFactory

@ParametersAreNonnullByDefault
public final class GrappaSslrFactory
extends java.lang.Object

A factory to create a Sonar parser based on a lexerful Grammar and a Grappa parser

The syntax to create a factory is:

     final GrappaSslrFactory factory = GrappaSslrFactory
         .withParserClass(MyParser.class)
         .withInjector(MyGrammar::myMethod)
         .withEntryPoint(someGrammarRuleKey)
         .build();
 

You then use the getParser() method to build a parser, which you will then use in an AstScanner.

Unless otherwise noted, all methods of this class do not accept null arguments; if a null argument is passed, a NullPointerException will be thrown.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GrappaSslrFactory.Builder<P extends SonarParserBase> A builder for a GrappaSslrFactory This class is not directly instantiable; use withParserClass(Class) to create a new instance.

Method Summary

Modifier and Type	Method and Description
com.sonar.sslr.impl.Parser<com.sonar.sslr.api.Grammar>	getParser() Get a Sonar Parser from this factory
static <P extends SonarParserBase> GrappaSslrFactory.Builder<P>	withParserClass(java.lang.Class<P> parserClass) Initialize a builder for a new factory

Methods inherited from class java.lang.Object

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

Method Detail

withParserClass

public static <P extends SonarParserBase> GrappaSslrFactory.Builder<P> withParserClass(java.lang.Class<P> parserClass)

Initialize a builder for a new factory

Type Parameters:

P - type of the parser

Parameters:

parserClass - the parser class

Returns:

a new builder

getParser

public com.sonar.sslr.impl.Parser<com.sonar.sslr.api.Grammar> getParser()

Get a Sonar Parser from this factory

Returns:

a new parser instance