Package org.antlr.v4.runtime.misc

Class RuleDependencyProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.antlr.v4.runtime.misc.RuleDependencyProcessor

All Implemented Interfaces:

Processor

@SupportedAnnotationTypes({"org.antlr.v4.runtime.RuleDependency","org.antlr.v4.runtime.RuleDependencies","org.antlr.v4.runtime.RuleVersion"})
public class RuleDependencyProcessor
extends AbstractProcessor

A compile-time validator for rule dependencies.

See Also:

• RuleDependency
• RuleDependencies

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RuleDependencyProcessor.RuleDependencyProperty
private static final class	RuleDependencyProcessor.RuleRelations

Field Summary

Fields

Modifier and Type	Field	Description
private static final Set<Dependents>	IMPLEMENTED_DEPENDENTS
static final String	RuleDependenciesClassName
static final String	RuleDependencyClassName
static final String	RuleVersionClassName

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor	Description
RuleDependencyProcessor()

Method Summary

Modifier and Type	Method	Description
private boolean	checkClassNameConstant(String className, Class<?> clazz)
private boolean	checkClassNameConstants()
private void	checkDependencies(List<Tuple2<RuleDependency,Element>> dependencies, TypeMirror recognizerType)
private int	checkDependencyVersion(Tuple2<RuleDependency,Element> dependency, String[] ruleNames, int[] ruleVersions, int relatedRule, String relation)
private RuleDependencyProcessor.RuleRelations	extractRuleRelations(TypeMirror recognizer)
private AnnotationValue	findRuleDependencyProperty(Tuple2<RuleDependency,Element> dependency, AnnotationMirror annotationMirror, RuleDependencyProcessor.RuleDependencyProperty property)
private Tuple2<AnnotationMirror,AnnotationValue>	findRuleDependencyProperty(Tuple2<RuleDependency,Element> dependency, RuleDependencyProcessor.RuleDependencyProperty property)
static List<Tuple2<RuleDependency,Element>>	getDependencies(RoundEnvironment roundEnv)
private static TypeMirror	getRecognizerType(RuleDependency dependency)
private ExecutableElement	getRuleMethod(TypeMirror recognizerClass, String name)
private String[]	getRuleNames(TypeMirror recognizerClass)
private int[]	getRuleVersions(TypeMirror recognizerClass, String[] ruleNames)
private String	getSerializedATN(TypeMirror recognizerClass)
SourceVersion	getSupportedSourceVersion()
private boolean	hasRuleVersionAnnotation(ExecutableElement method)
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)
private void	reportUnimplementedDependents(Tuple2<RuleDependency,Element> dependency, EnumSet<Dependents> dependents)

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, getSupportedAnnotationTypes, getSupportedOptions, init, isInitialized

Methods inherited from class java.lang.Object

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

Field Details

RuleDependencyClassName

public static final String RuleDependencyClassName

See Also:

• Constant Field Values

RuleDependenciesClassName

public static final String RuleDependenciesClassName

See Also:

• Constant Field Values

RuleVersionClassName

public static final String RuleVersionClassName

See Also:

• Constant Field Values

IMPLEMENTED_DEPENDENTS

private static final Set<Dependents> IMPLEMENTED_DEPENDENTS

Constructor Details

RuleDependencyProcessor

public RuleDependencyProcessor()

Method Details

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

Specified by:

getSupportedSourceVersion in interface Processor

Overrides:

getSupportedSourceVersion in class AbstractProcessor

process

public boolean process(Set<? extends TypeElement> annotations,
 RoundEnvironment roundEnv)

Specified by:

process in interface Processor

Specified by:

process in class AbstractProcessor

checkClassNameConstants

private boolean checkClassNameConstants()

checkClassNameConstant

private boolean checkClassNameConstant(String className,
 Class<?> clazz)

getRecognizerType

private static TypeMirror getRecognizerType(RuleDependency dependency)

checkDependencies

private void checkDependencies(List<Tuple2<RuleDependency,Element>> dependencies,
 TypeMirror recognizerType)

reportUnimplementedDependents

private void reportUnimplementedDependents(Tuple2<RuleDependency,Element> dependency,
 EnumSet<Dependents> dependents)

checkDependencyVersion

private int checkDependencyVersion(Tuple2<RuleDependency,Element> dependency,
 String[] ruleNames,
 int[] ruleVersions,
 int relatedRule,
 String relation)

getRuleVersions

private int[] getRuleVersions(TypeMirror recognizerClass,
 String[] ruleNames)

getRuleMethod

private ExecutableElement getRuleMethod(TypeMirror recognizerClass,
 String name)

hasRuleVersionAnnotation

private boolean hasRuleVersionAnnotation(ExecutableElement method)

getRuleNames

private String[] getRuleNames(TypeMirror recognizerClass)

getDependencies

public static List<Tuple2<RuleDependency,Element>> getDependencies(RoundEnvironment roundEnv)

findRuleDependencyProperty

@Nullable
private Tuple2<AnnotationMirror,AnnotationValue> findRuleDependencyProperty(@NotNull
 Tuple2<RuleDependency,Element> dependency,
 @NotNull
 RuleDependencyProcessor.RuleDependencyProperty property)

findRuleDependencyProperty

@Nullable
private AnnotationValue findRuleDependencyProperty(@NotNull
 Tuple2<RuleDependency,Element> dependency,
 @NotNull
 AnnotationMirror annotationMirror,
 @NotNull
 RuleDependencyProcessor.RuleDependencyProperty property)

extractRuleRelations

private RuleDependencyProcessor.RuleRelations extractRuleRelations(TypeMirror recognizer)

getSerializedATN

private String getSerializedATN(TypeMirror recognizerClass)