org.antlr.v4.runtime.misc

Class NullUsageProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.antlr.v4.runtime.misc.NullUsageProcessor

All Implemented Interfaces:

javax.annotation.processing.Processor

@SupportedAnnotationTypes(value={"org.antlr.v4.runtime.misc.NotNull","org.antlr.v4.runtime.misc.Nullable"})
public class NullUsageProcessor
extends javax.annotation.processing.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 and Description
static java.lang.String	NotNullClassName
static java.lang.String	NullableClassName

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
NullUsageProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
javax.lang.model.SourceVersion	getSupportedSourceVersion()
boolean	process(java.util.Set<? extends javax.lang.model.element.TypeElement> annotations, javax.annotation.processing.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 Detail

NotNullClassName

public static final java.lang.String NotNullClassName

See Also:

Constant Field Values

NullableClassName

public static final java.lang.String NullableClassName

See Also:

Constant Field Values

Constructor Detail

NullUsageProcessor

public NullUsageProcessor()

Method Detail

getSupportedSourceVersion

public javax.lang.model.SourceVersion getSupportedSourceVersion()

Specified by:

getSupportedSourceVersion in interface javax.annotation.processing.Processor

Overrides:

getSupportedSourceVersion in class javax.annotation.processing.AbstractProcessor

process

public boolean process(java.util.Set<? extends javax.lang.model.element.TypeElement> annotations,
              javax.annotation.processing.RoundEnvironment roundEnv)

Specified by:

process in interface javax.annotation.processing.Processor

Specified by:

process in class javax.annotation.processing.AbstractProcessor