All Implemented Interfaces:


public abstract class BaseParsingHelper<Self extends BaseParsingHelper<Self, T>, T extends RootNode>

Language-independent base for a parser utils class. Implementations are language-specific.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`BaseParsingHelper.Params`

Field Summary

Fields
Modifier and Type	Field	Description
`private final Language`	`language`
`private final LanguageVersion`	`defaultVersion`
`private final LanguageVersionHandler`	`defaultHandler`

Constructor Summary

Constructors
Constructor	Description
`BaseParsingHelper(String langName, Class<T> rootClass, BaseParsingHelper.Params params)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Language`	`getLanguage()`
`final LanguageVersion`	`getDefaultVersion()`
`final LanguageVersionHandler`	`getDefaultHandler()`
`final LanguageVersion`	`getVersion(String version)`	Returns the language version with the given version string.
`final Self`	`withDefaultVersion(String version)`	Returns an instance of Self for which all parsing methods default their language version to the provided version If the version is null, then the default language version defined by the language module is used instead.
`final Self`	`withResourceContext(Class<?> contextClass, String resourcePrefix)`	Returns an instance of Self for which parseResource uses the provided contextClass and resourcePrefix to load resources.
`final Self`	`withResourceContext(Class<?> contextClass)`	Returns an instance of Self for which parseResource uses the provided contextClass and resourcePrefix to load resources.
`final Self`	`withParserOptions(ParserOptions parserOptions)`	Returns an instance of Self for which the parse methods use the provided parserOptions.
`final LanguageVersionHandler`	`getHandler(String version)`
`final <R extends Node> List<R>`	`getNodes(Class<R> target, String source, String version)`
`final <R extends Node> List<R>`	`getNodes(Class<R> target, String source)`
`T`	`parse(String sourceCode, String version, String fileName)`	Parses the sourceCode with the given version.
`T`	`parse(String sourceCode, String version)`	Parses the sourceCode with the given version.
`T`	`parse(String sourceCode)`	Parses the sourceCode with the given version.
`T`	`parseResource(String resource, String version)`	Fetches and parses the resource using the context defined for this instance (by default uses this class' classloader, but can be configured with withResourceContext).
`T`	`parseResource(String resource)`	Fetches and parses the resource using the context defined for this instance (by default uses this class' classloader, but can be configured with withResourceContext).
`T`	`parseClass(Class<?> clazz, String version)`	Fetches the source of the given clazz.
`T`	`parseClass(Class<?> clazz)`	Fetches the source of the given clazz.
`final Report`	`executeRule(Rule rule, String code, String filename)`	Execute the given rule on the code.
`final Report`	`executeRule(Rule rule, String code)`	Execute the given rule on the code.
`final Report`	`executeRuleOnResource(Rule rule, String resourcePath)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BaseParsingHelper
```
BaseParsingHelper(String langName, Class<T> rootClass, BaseParsingHelper.Params params)
```
- Method Detail
  - getLanguage
```
 final Language getLanguage()
```
  - getDefaultVersion
```
 final LanguageVersion getDefaultVersion()
```
  - getDefaultHandler
```
 final LanguageVersionHandler getDefaultHandler()
```
  - getVersion
```
 final LanguageVersion getVersion(String version)
```
    Returns the language version with the given version string. If null, this defaults to the default language version for this instance (not necessarily the default language version defined by the language module).
  - withDefaultVersion
```
 final Self withDefaultVersion(String version)
```
    Returns an instance of Self for which all parsing methods default their language version to the provided version If the version is null, then the default language version defined by the language module is used instead.
  - withResourceContext
```
@JvmOverloads() final Self withResourceContext(Class<?> contextClass, String resourcePrefix)
```
    Returns an instance of Self for which parseResource uses the provided contextClass and resourcePrefix to load resources.
  - withResourceContext
```
@JvmOverloads() final Self withResourceContext(Class<?> contextClass)
```
    Returns an instance of Self for which parseResource uses the provided contextClass and resourcePrefix to load resources.
  - withParserOptions
```
 final Self withParserOptions(ParserOptions parserOptions)
```
    Returns an instance of Self for which the parse methods use the provided parserOptions.
  - getHandler
```
 final LanguageVersionHandler getHandler(String version)
```
  - getNodes
```
@JvmOverloads() final <R extends Node> List<R> getNodes(Class<R> target, String source, String version)
```
  - getNodes
```
@JvmOverloads() final <R extends Node> List<R> getNodes(Class<R> target, String source)
```
  - parse
```
@JvmOverloads() T parse(String sourceCode, String version, String fileName)
```
    Parses the sourceCode with the given version. This may execute additional processing passes if this instance is configured to do so.
  - parse
```
@JvmOverloads() T parse(String sourceCode, String version)
```
    Parses the sourceCode with the given version. This may execute additional processing passes if this instance is configured to do so.
  - parse
```
@JvmOverloads() T parse(String sourceCode)
```
    Parses the sourceCode with the given version. This may execute additional processing passes if this instance is configured to do so.
  - parseResource
```
@JvmOverloads() T parseResource(String resource, String version)
```
    Fetches and parses the resource using the context defined for this instance (by default uses this class' classloader, but can be configured with withResourceContext).
  - parseResource
```
@JvmOverloads() T parseResource(String resource)
```
    Fetches and parses the resource using the context defined for this instance (by default uses this class' classloader, but can be configured with withResourceContext).
  - parseClass
```
@JvmOverloads() T parseClass(Class<?> clazz, String version)
```
    Fetches the source of the given clazz.
  - parseClass
```
@JvmOverloads() T parseClass(Class<?> clazz)
```
    Fetches the source of the given clazz.
  - executeRule
```
@JvmOverloads() final Report executeRule(Rule rule, String code, String filename)
```
    Execute the given rule on the code. Produce a report with the violations found by the rule. The language version of the piece of code is determined by the params.
  - executeRule
```
@JvmOverloads() final Report executeRule(Rule rule, String code)
```
    Execute the given rule on the code. Produce a report with the violations found by the rule. The language version of the piece of code is determined by the params.
  - executeRuleOnResource
```
 final Report executeRuleOnResource(Rule rule, String resourcePath)
```

Class BaseParsingHelper

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BaseParsingHelper

Method Detail

getLanguage

getDefaultVersion

getDefaultHandler

getVersion

withDefaultVersion

withResourceContext

withResourceContext

withParserOptions

getHandler

getNodes

getNodes

parse

parse

parse

parseResource

parseResource

parseClass

parseClass

executeRule

executeRule

executeRuleOnResource