checkers.nullness

Class NullnessSubchecker

java.lang.Object

javax.annotation.processing.AbstractProcessor

checkers.source.AbstractTypeProcessor

checkers.source.SourceChecker

checkers.basetype.BaseTypeChecker

checkers.nullness.NullnessSubchecker

All Implemented Interfaces:

Processor

public class NullnessSubchecker
extends BaseTypeChecker

A typechecker plug-in for the Nullness type system qualifier that finds (and verifies the absence of) null-pointer errors.

See Also:

NonNull, Nullable, Raw

See the Checker Framework manual:

Nullness Checker

Nested Class Summary

Nested classes/interfaces inherited from class checkers.source.SourceChecker

SourceChecker.CheckerError

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	ADVANCEDCHECKS_DEFAULT
protected @Nullable AnnotationMirror	LAZYNONNULL
protected @Nullable AnnotationMirror	NONNULL
protected @Nullable AnnotationMirror	NULLABLE
static boolean	NULLTEST_DEFAULT
protected @Nullable AnnotationMirror	POLYNULL
protected @Nullable AnnotationMirror	PRIMITIVE
protected RawnessSubchecker	rawnesschecker
static boolean	UNINIT_DEFAULT

Fields inherited from class checkers.source.SourceChecker

currentPath, currentRoot, messager, messages, trees

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
NullnessSubchecker()

Method Summary

Methods

Modifier and Type	Method and Description
AnnotatedTypeFactory	createFactory(@Nullable CompilationUnitTree root) Constructs an instance of the appropriate type factory for the implemented type system.
QualifierHierarchy	createQualifierHierarchy(MultiGraphQualifierHierarchy.MultiGraphFactory factory) Factory method to easily change what QualifierHierarchy is created.
protected MultiGraphQualifierHierarchy.MultiGraphFactory	createQualifierHierarchyFactory() Factory method to easily change what Factory is used to create a QualifierHierarchy.
protected TypeHierarchy	createTypeHierarchy() Creates the type subtyping checker using the current type qualifier hierarchy.
void	initChecker() Initialize the checker.

Methods inherited from class checkers.basetype.BaseTypeChecker

createQualifierHierarchy, createSourceVisitor, createSupportedTypeQualifiers, getQualifierHierarchy, getSupportedLintOptions, getSupportedTypeQualifiers, getTypeHierarchy, invokeConstructorFor

Methods inherited from class checkers.source.SourceChecker

errorAbort, errorAbort, formatStackTrace, fullMessageOf, getLintOption, getLintOption, getMessages, getProcessingEnvironment, getProperties, getSupportedAnnotationTypes, getSupportedOptions, getSupportedSourceVersion, getSuppressWarningsKey, message, report, shouldSkipDefs, shouldSkipDefs, shouldSkipUses, typeProcess, typeProcessingStart

Methods inherited from class checkers.source.AbstractTypeProcessor

init, process, typeProcessingOver

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, isInitialized, toString

Methods inherited from class java.lang.Object

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

Field Detail

UNINIT_DEFAULT

public static final boolean UNINIT_DEFAULT

See Also:

Constant Field Values

NULLTEST_DEFAULT

public static final boolean NULLTEST_DEFAULT

See Also:

Constant Field Values

ADVANCEDCHECKS_DEFAULT

public static final boolean ADVANCEDCHECKS_DEFAULT

See Also:

Constant Field Values

NONNULL

protected @Nullable AnnotationMirror NONNULL

NULLABLE

protected @Nullable AnnotationMirror NULLABLE

LAZYNONNULL

protected @Nullable AnnotationMirror LAZYNONNULL

PRIMITIVE

protected @Nullable AnnotationMirror PRIMITIVE

POLYNULL

protected @Nullable AnnotationMirror POLYNULL

rawnesschecker

protected RawnessSubchecker rawnesschecker

Constructor Detail

NullnessSubchecker

public NullnessSubchecker()

Method Detail

initChecker

public void initChecker()

Description copied from class: SourceChecker

Initialize the checker.

Overrides:

initChecker in class BaseTypeChecker

See Also:

AbstractProcessor.init(ProcessingEnvironment)

createFactory

public AnnotatedTypeFactory createFactory(@Nullable CompilationUnitTree root)

Description copied from class: BaseTypeChecker

Constructs an instance of the appropriate type factory for the implemented type system. The default implementation uses the checker naming convention to create the appropriate type factory. If no factory is found, it returns BasicAnnotatedTypeFactory. It reflectively invokes the constructor that accepts this checker and compilation unit tree (in that order) as arguments. Subclasses have to override this method to create the appropriate visitor if they do not follow the checker naming convention.

Overrides:

createFactory in class BaseTypeChecker

Parameters:

root - the currently visited compilation unit

Returns:

the appropriate type factory

createTypeHierarchy

protected TypeHierarchy createTypeHierarchy()

Description copied from class: BaseTypeChecker

Creates the type subtyping checker using the current type qualifier hierarchy. Subclasses may override this method to specify new type checking rules beyond the typical java subtyping rules.

Overrides:

createTypeHierarchy in class BaseTypeChecker

Returns:

the type relations class to check type subtyping

createQualifierHierarchyFactory

protected MultiGraphQualifierHierarchy.MultiGraphFactory createQualifierHierarchyFactory()

Description copied from class: BaseTypeChecker

Factory method to easily change what Factory is used to create a QualifierHierarchy.

Overrides:

createQualifierHierarchyFactory in class BaseTypeChecker

createQualifierHierarchy

public QualifierHierarchy createQualifierHierarchy(MultiGraphQualifierHierarchy.MultiGraphFactory factory)

Description copied from class: BaseTypeChecker

Factory method to easily change what QualifierHierarchy is created. Needs to be public only because the GraphFactory must be able to call this method. No external use of this method is necessary.

Overrides:

createQualifierHierarchy in class BaseTypeChecker