Package org.antlr.v4.runtime.misc

Class NullUsageProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.antlr.v4.runtime.misc.NullUsageProcessor

All Implemented Interfaces:

Processor

@SupportedAnnotationTypes({"org.antlr.v4.runtime.misc.NotNull","org.antlr.v4.runtime.misc.Nullable"})
public class NullUsageProcessor
extends AbstractProcessor

A compile-time validator for correct usage of the NotNull and Nullable annotations.

The validation process checks the following items.

• Error: an element is annotated with both NotNull and Nullable.
• Error: an method which returns void is annotated with NotNull or Nullable.
• Error: an element with a primitive type is annotated with Nullable.
• Error: a parameter is annotated with NotNull, but the method overrides or implements a method where the parameter is annotated Nullable.
• Error: a method is annotated with Nullable, but the method overrides or implements a method that is annotated with NotNull.
• Warning: an element with a primitive type is annotated with NotNull.
• Warning: a parameter is annotated with NotNull, but the method overrides or implements a method where the parameter is not annotated.
• Warning: a method is annotated with Nullable, but the method overrides or implements a method that is not annotated.

In the future, the validation process may be updated to check the following additional items.

• Warning: a parameter is not annotated, but the method overrides or implements a method where the parameter is annotated with NotNull or Nullable.
• Warning: a method is not annotated, but the method overrides or implements a method that is annotated with with NotNull or Nullable.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NotNullClassName
private TypeElement	notNullType
static final String	NullableClassName
private TypeElement	nullableType

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor	Description
NullUsageProcessor()

Method Summary

Modifier and Type	Method	Description
private void	addElementsToNamedMethodMap(Set<? extends Element> elements, Map<String,Map<ExecutableElement,List<Element>>> namedMethodMap)
private boolean	checkClassNameConstant(String className, Class<?> clazz)
private boolean	checkClassNameConstants()
private void	checkOverriddenMethod(ExecutableElement overrider, ExecutableElement overridden, Set<Element> errorElements, Set<Element> warnedElements)
private void	checkOverriddenMethods(ExecutableElement method)
private void	checkPrimitiveTypeAnnotations(Set<? extends Element> elements, Diagnostic.Kind kind, TypeElement annotationType)
private void	checkVoidMethodAnnotations(Set<? extends Element> elements, TypeElement annotationType)
private List<? extends TypeMirror>	getAllSupertypes(TypeMirror type)
private AnnotationMirror	getAnnotationMirror(Element element, TypeElement annotationType)
private AnnotationMirror	getNotNullAnnotationMirror(Element element)
private AnnotationMirror	getNullableAnnotationMirror(Element element)
SourceVersion	getSupportedSourceVersion()
private boolean	isNotNull(Element element)
private boolean	isNullable(Element element)
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)

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

NotNullClassName

public static final String NotNullClassName

See Also:

• Constant Field Values

NullableClassName

public static final String NullableClassName

See Also:

• Constant Field Values

notNullType

private TypeElement notNullType

nullableType

private TypeElement nullableType

Constructor Details

NullUsageProcessor

public NullUsageProcessor()

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)

checkVoidMethodAnnotations

private void checkVoidMethodAnnotations(Set<? extends Element> elements,
 TypeElement annotationType)

checkPrimitiveTypeAnnotations

private void checkPrimitiveTypeAnnotations(Set<? extends Element> elements,
 Diagnostic.Kind kind,
 TypeElement annotationType)

addElementsToNamedMethodMap

private void addElementsToNamedMethodMap(Set<? extends Element> elements,
 Map<String,Map<ExecutableElement,List<Element>>> namedMethodMap)

checkOverriddenMethods

private void checkOverriddenMethods(ExecutableElement method)

getAllSupertypes

private List<? extends TypeMirror> getAllSupertypes(TypeMirror type)

checkOverriddenMethod

private void checkOverriddenMethod(ExecutableElement overrider,
 ExecutableElement overridden,
 Set<Element> errorElements,
 Set<Element> warnedElements)

isNotNull

private boolean isNotNull(Element element)

isNullable

private boolean isNullable(Element element)

getNotNullAnnotationMirror

private AnnotationMirror getNotNullAnnotationMirror(Element element)

getNullableAnnotationMirror

private AnnotationMirror getNullableAnnotationMirror(Element element)

getAnnotationMirror

private AnnotationMirror getAnnotationMirror(Element element,
 TypeElement annotationType)