ANTLR 4 Runtime Annotations 4.3 · org.antlr.v4.runtime.misc.NullUsageProcessor

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

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

Inherited from javax.annotation.processing.AbstractProcessor:: processingEnv

Constructor Summary

Access	Constructor and Description
public	NullUsageProcessor()

Method Summary

Modifier and Type	Method and 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)
private boolean	isNotNull(Element element)
private boolean	isNullable(Element element)
public boolean	process(Set<? extends TypeElement> the annotation interfaces requested to be processed annotations, RoundEnvironment environment for information about the current and prior round roundEnv) Implements abstract javax.annotation.processing.AbstractProcessor.process. Implements javax.annotation.processing.Processor.process. Processes a set of annotation interfaces on root elements originating from the prior round and returns whether or not these annotation interfaces are claimed by this processor.

Inherited from javax.annotation.processing.AbstractProcessor:: getCompletions getSupportedAnnotationTypes getSupportedOptions getSupportedSourceVersion init isInitialized

Field Detail

NotNullClassName	back to summary
public static final String NotNullClassName

notNullType	back to summary
private TypeElement notNullType

NullableClassName	back to summary
public static final String NullableClassName

nullableType	back to summary
private TypeElement nullableType

Constructor Detail

NullUsageProcessor	back to summary
public NullUsageProcessor()

Method Detail

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

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

checkClassNameConstants	back to summary
private boolean checkClassNameConstants()

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

checkOverriddenMethods	back to summary
private void checkOverriddenMethods(ExecutableElement method)

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

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

getAllSupertypes	back to summary
private List<? extends TypeMirror> getAllSupertypes(TypeMirror type)

getAnnotationMirror	back to summary
private AnnotationMirror getAnnotationMirror(Element element, TypeElement annotationType)

getNotNullAnnotationMirror	back to summary
private AnnotationMirror getNotNullAnnotationMirror(Element element)

getNullableAnnotationMirror	back to summary
private AnnotationMirror getNullableAnnotationMirror(Element element)

isNotNull	back to summary
private boolean isNotNull(Element element)

isNullable	back to summary
private boolean isNullable(Element element)

process back to summary

process	back to summary
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) Implements abstract javax.annotation.processing.AbstractProcessor.process. Implements javax.annotation.processing.Processor.process. Doc from javax.annotation.processing.AbstractProcessor.process. Processes a set of annotation interfaces on root elements originating from the prior round and returns whether or not these annotation interfaces are claimed by this processor. If `true` is returned, the annotation interfaces are claimed and subsequent processors will not be asked to process them; if `false` is returned, the annotation interfaces are unclaimed and subsequent processors may be asked to process them. A processor may always return the same boolean value or may vary the result based on its own chosen criteria. The input set will be empty if the processor supports `"*"` and the root elements have no annotations. A `Processor` must gracefully handle an empty set of annotations. Parameters annotations:Set<? extends TypeElement> Doc from javax.annotation.processing.Processor.process. the annotation interfaces requested to be processed roundEnv:RoundEnvironment Doc from javax.annotation.processing.Processor.process. environment for information about the current and prior round Returns:boolean Doc from javax.annotation.processing.Processor.process. whether or not the set of annotation interfaces are claimed by this processor Annotations @Override

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

Implements abstract javax.annotation.processing.AbstractProcessor.process.

Implements javax.annotation.processing.Processor.process.

Doc from javax.annotation.processing.AbstractProcessor.process.

Processes a set of annotation interfaces on root elements originating from the prior round and returns whether or not these annotation interfaces are claimed by this processor. If true is returned, the annotation interfaces are claimed and subsequent processors will not be asked to process them; if false is returned, the annotation interfaces are unclaimed and subsequent processors may be asked to process them. A processor may always return the same boolean value or may vary the result based on its own chosen criteria.

The input set will be empty if the processor supports "*" and the root elements have no annotations. A Processor must gracefully handle an empty set of annotations.

Parameters

annotations:Set<? extends TypeElement>

Doc from javax.annotation.processing.Processor.process.

the annotation interfaces requested to be processed

roundEnv:RoundEnvironment

Doc from javax.annotation.processing.Processor.process.

environment for information about the current and prior round

Returns:boolean

Doc from javax.annotation.processing.Processor.process.

whether or not the set of annotation interfaces are claimed by this processor

Annotations

@Override

public Class NullUsageProcessor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail