org.checkerframework.checker.nullness

Class NullnessVisitor

java.lang.Object

com.sun.source.util.TreeScanner<R,P>

com.sun.source.util.TreePathScanner<R,P>

org.checkerframework.framework.source.SourceVisitor<java.lang.Void,java.lang.Void>

org.checkerframework.common.basetype.BaseTypeVisitor<Factory>

org.checkerframework.checker.initialization.InitializationVisitor<NullnessAnnotatedTypeFactory,NullnessValue,NullnessStore>

org.checkerframework.checker.nullness.NullnessVisitor

All Implemented Interfaces:

TreeVisitor<java.lang.Void,java.lang.Void>

public class NullnessVisitor
extends InitializationVisitor<NullnessAnnotatedTypeFactory,NullnessValue,NullnessStore>

The visitor for the nullness type-system.

Nested Class Summary

Nested classes/interfaces inherited from class org.checkerframework.common.basetype.BaseTypeVisitor

org.checkerframework.common.basetype.BaseTypeVisitor.OverrideChecker

Field Summary

Fields inherited from class org.checkerframework.checker.initialization.InitializationVisitor

annoFormatter, initializedFields

Fields inherited from class org.checkerframework.common.basetype.BaseTypeVisitor

atypeFactory, checker, contractsUtils, positions, typeValidator, visitorState

Fields inherited from class org.checkerframework.framework.source.SourceVisitor

elements, root, trees, treesWithSuppressWarnings, types

Constructor Summary

Constructors

Constructor and Description
NullnessVisitor(org.checkerframework.common.basetype.BaseTypeChecker checker, boolean useFbc)

Method Summary

Modifier and Type	Method and Description
protected void	checkExceptionParameter(CatchTree node)
protected void	checkForRedundantTests(BinaryTree node) Reports an error if a comparison of a @NonNull expression with the null literal is performed.
protected void	checkMethodInvocability(org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedExecutableType method, MethodInvocationTree node)
protected void	checkThrownExpression(ThrowTree node) Case 4: Check for thrown exception nullness
protected void	commonAssignmentCheck(org.checkerframework.framework.type.AnnotatedTypeMirror varType, org.checkerframework.framework.type.AnnotatedTypeMirror valueType, Tree valueTree, @CompilerMessageKey java.lang.String errorKey)
protected void	commonAssignmentCheck(org.checkerframework.framework.type.AnnotatedTypeMirror varType, ExpressionTree valueExp, @CompilerMessageKey java.lang.String errorKey)
protected void	commonAssignmentCheck(Tree varTree, ExpressionTree valueExp, @CompilerMessageKey java.lang.String errorKey)
NullnessAnnotatedTypeFactory	createTypeFactory()
boolean	isValidUse(org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedDeclaredType declarationType, org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedDeclaredType useType, Tree tree)
boolean	isValidUse(org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedPrimitiveType type, Tree tree)
java.lang.Void	visitArrayAccess(ArrayAccessTree node, java.lang.Void p) Case 3: Check for array dereferencing
java.lang.Void	visitAssert(AssertTree node, java.lang.Void p)
java.lang.Void	visitBinary(BinaryTree node, java.lang.Void p) Case 6: Check for redundant nullness tests Case 7: unboxing case: primitive operations
java.lang.Void	visitCompoundAssignment(CompoundAssignmentTree node, java.lang.Void p) Case 7: unboxing case: primitive operation
java.lang.Void	visitConditionalExpression(ConditionalExpressionTree node, java.lang.Void p)
java.lang.Void	visitDoWhileLoop(DoWhileLoopTree node, java.lang.Void p)
java.lang.Void	visitEnhancedForLoop(EnhancedForLoopTree node, java.lang.Void p) Case 2: Check for implicit .iterator call
java.lang.Void	visitForLoop(ForLoopTree node, java.lang.Void p)
java.lang.Void	visitIf(IfTree node, java.lang.Void p)
java.lang.Void	visitMemberSelect(MemberSelectTree node, java.lang.Void p) Case 1: Check for null dereferencing
java.lang.Void	visitNewArray(NewArrayTree node, java.lang.Void p)
java.lang.Void	visitNewClass(NewClassTree node, java.lang.Void p)
java.lang.Void	visitSwitch(SwitchTree node, java.lang.Void p)
java.lang.Void	visitSynchronized(SynchronizedTree node, java.lang.Void p) Case 5: Check for synchronizing locks
java.lang.Void	visitTypeCast(TypeCastTree node, java.lang.Void p) Case 7: unboxing case: casting to a primitive
java.lang.Void	visitUnary(UnaryTree node, java.lang.Void p) Case 7: unboxing case: primitive operation
java.lang.Void	visitWhileLoop(WhileLoopTree node, java.lang.Void p)

Methods inherited from class org.checkerframework.checker.initialization.InitializationVisitor

checkConstructorInvocation, checkContract, checkFieldsInitialized, processClassTree, setRoot, visitMethod, visitVariable

Methods inherited from class org.checkerframework.common.basetype.BaseTypeVisitor

checkAccess, checkArguments, checkArrayInitialization, checkAssignability, checkConditionalPostcondition, checkDefaultConstructor, checkFieldInvariantDeclarations, checkForAnnotatedJdk, checkMethodReferenceAsOverride, checkOverride, checkOverride, checkPostcondition, checkPreconditions, checkTypeArguments, checkTypecastRedundancy, checkTypecastSafety, checkVarargs, createOverrideChecker, createTypeValidator, enclosingMemberSelect, enclosingStatement, getExceptionParameterLowerBoundAnnotations, getThrowUpperBoundAnnotations, getTypeFactory, isAccessAllowed, isAssignable, isValidUse, isVectorCopyInto, reportPurityErrors, scan, shouldSkipUses, skipReceiverSubtypeCheck, testTypevarContainment, typeCheckVectorCopyIntoArgument, validateType, validateTypeOf, visitAnnotation, visitAssignment, visitCatch, visitClass, visitCompilationUnit, visitIdentifier, visitInstanceOf, visitLambdaExpression, visitMemberReference, visitMethodInvocation, visitParameterizedType, visitReturn, visitThrow, visitTypeParameter

Methods inherited from class org.checkerframework.framework.source.SourceVisitor

visit

Methods inherited from class com.sun.source.util.TreePathScanner

getCurrentPath, scan

Methods inherited from class com.sun.source.util.TreeScanner

reduce, scan, visitAnnotatedType, visitArrayType, visitBlock, visitBreak, visitCase, visitContinue, visitEmptyStatement, visitErroneous, visitExpressionStatement, visitImport, visitIntersectionType, visitLabeledStatement, visitLiteral, visitModifiers, visitOther, visitParenthesized, visitPrimitiveType, visitTry, visitUnionType, visitWildcard

Methods inherited from class java.lang.Object

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

Constructor Detail

NullnessVisitor

public NullnessVisitor(org.checkerframework.common.basetype.BaseTypeChecker checker,
                       boolean useFbc)

Method Detail

createTypeFactory

public NullnessAnnotatedTypeFactory createTypeFactory()

Overrides:

createTypeFactory in class org.checkerframework.common.basetype.BaseTypeVisitor<NullnessAnnotatedTypeFactory>

isValidUse

public boolean isValidUse(org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedDeclaredType declarationType,
                          org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedDeclaredType useType,
                          Tree tree)

Overrides:

isValidUse in class org.checkerframework.common.basetype.BaseTypeVisitor<NullnessAnnotatedTypeFactory>

isValidUse

public boolean isValidUse(org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedPrimitiveType type,
                          Tree tree)

Overrides:

isValidUse in class org.checkerframework.common.basetype.BaseTypeVisitor<NullnessAnnotatedTypeFactory>

commonAssignmentCheck

protected void commonAssignmentCheck(Tree varTree,
                                     ExpressionTree valueExp,
                                     @CompilerMessageKey java.lang.String errorKey)

Overrides:

commonAssignmentCheck in class InitializationVisitor<NullnessAnnotatedTypeFactory,NullnessValue,NullnessStore>

commonAssignmentCheck

protected void commonAssignmentCheck(org.checkerframework.framework.type.AnnotatedTypeMirror varType,
                                     ExpressionTree valueExp,
                                     @CompilerMessageKey java.lang.String errorKey)

Overrides:

commonAssignmentCheck in class org.checkerframework.common.basetype.BaseTypeVisitor<NullnessAnnotatedTypeFactory>

commonAssignmentCheck

protected void commonAssignmentCheck(org.checkerframework.framework.type.AnnotatedTypeMirror varType,
                                     org.checkerframework.framework.type.AnnotatedTypeMirror valueType,
                                     Tree valueTree,
                                     @CompilerMessageKey java.lang.String errorKey)

Overrides:

commonAssignmentCheck in class org.checkerframework.common.basetype.BaseTypeVisitor<NullnessAnnotatedTypeFactory>

visitMemberSelect

public java.lang.Void visitMemberSelect(MemberSelectTree node,
                                        java.lang.Void p)

Case 1: Check for null dereferencing

Specified by:

visitMemberSelect in interface TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitMemberSelect in class TreeScanner<java.lang.Void,java.lang.Void>

visitEnhancedForLoop

public java.lang.Void visitEnhancedForLoop(EnhancedForLoopTree node,
                                           java.lang.Void p)

Case 2: Check for implicit .iterator call

Specified by:

visitEnhancedForLoop in interface TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitEnhancedForLoop in class org.checkerframework.common.basetype.BaseTypeVisitor<NullnessAnnotatedTypeFactory>

visitArrayAccess

public java.lang.Void visitArrayAccess(ArrayAccessTree node,
                                       java.lang.Void p)

Case 3: Check for array dereferencing

Specified by:

visitArrayAccess in interface TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitArrayAccess in class org.checkerframework.common.basetype.BaseTypeVisitor<NullnessAnnotatedTypeFactory>

visitNewArray

public java.lang.Void visitNewArray(NewArrayTree node,
                                    java.lang.Void p)

Specified by:

visitNewArray in interface TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitNewArray in class org.checkerframework.common.basetype.BaseTypeVisitor<NullnessAnnotatedTypeFactory>

checkThrownExpression

protected void checkThrownExpression(ThrowTree node)

Case 4: Check for thrown exception nullness

Overrides:

checkThrownExpression in class org.checkerframework.common.basetype.BaseTypeVisitor<NullnessAnnotatedTypeFactory>

visitSynchronized

public java.lang.Void visitSynchronized(SynchronizedTree node,
                                        java.lang.Void p)

Case 5: Check for synchronizing locks

Specified by:

visitSynchronized in interface TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitSynchronized in class TreeScanner<java.lang.Void,java.lang.Void>

visitAssert

public java.lang.Void visitAssert(AssertTree node,
                                  java.lang.Void p)

Specified by:

visitAssert in interface TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitAssert in class TreeScanner<java.lang.Void,java.lang.Void>

visitIf

public java.lang.Void visitIf(IfTree node,
                              java.lang.Void p)

Specified by:

visitIf in interface TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitIf in class TreeScanner<java.lang.Void,java.lang.Void>

checkForRedundantTests

protected void checkForRedundantTests(BinaryTree node)

Reports an error if a comparison of a @NonNull expression with the null literal is performed.

visitBinary

public java.lang.Void visitBinary(BinaryTree node,
                                  java.lang.Void p)

Case 6: Check for redundant nullness tests Case 7: unboxing case: primitive operations

Specified by:

visitBinary in interface TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitBinary in class TreeScanner<java.lang.Void,java.lang.Void>

visitUnary

public java.lang.Void visitUnary(UnaryTree node,
                                 java.lang.Void p)

Case 7: unboxing case: primitive operation

Specified by:

visitUnary in interface TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitUnary in class org.checkerframework.common.basetype.BaseTypeVisitor<NullnessAnnotatedTypeFactory>

visitCompoundAssignment

public java.lang.Void visitCompoundAssignment(CompoundAssignmentTree node,
                                              java.lang.Void p)

Case 7: unboxing case: primitive operation

Specified by:

visitCompoundAssignment in interface TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitCompoundAssignment in class org.checkerframework.common.basetype.BaseTypeVisitor<NullnessAnnotatedTypeFactory>

visitTypeCast

public java.lang.Void visitTypeCast(TypeCastTree node,
                                    java.lang.Void p)

Case 7: unboxing case: casting to a primitive

Specified by:

visitTypeCast in interface TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitTypeCast in class InitializationVisitor<NullnessAnnotatedTypeFactory,NullnessValue,NullnessStore>

checkMethodInvocability

protected void checkMethodInvocability(org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedExecutableType method,
                                       MethodInvocationTree node)

Overrides:

checkMethodInvocability in class org.checkerframework.common.basetype.BaseTypeVisitor<NullnessAnnotatedTypeFactory>

visitSwitch

public java.lang.Void visitSwitch(SwitchTree node,
                                  java.lang.Void p)

Specified by:

visitSwitch in interface TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitSwitch in class TreeScanner<java.lang.Void,java.lang.Void>

visitForLoop

public java.lang.Void visitForLoop(ForLoopTree node,
                                   java.lang.Void p)

Specified by:

visitForLoop in interface TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitForLoop in class TreeScanner<java.lang.Void,java.lang.Void>

visitNewClass

public java.lang.Void visitNewClass(NewClassTree node,
                                    java.lang.Void p)

Specified by:

visitNewClass in interface TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitNewClass in class org.checkerframework.common.basetype.BaseTypeVisitor<NullnessAnnotatedTypeFactory>

visitWhileLoop

public java.lang.Void visitWhileLoop(WhileLoopTree node,
                                     java.lang.Void p)

Specified by:

visitWhileLoop in interface TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitWhileLoop in class TreeScanner<java.lang.Void,java.lang.Void>

visitDoWhileLoop

public java.lang.Void visitDoWhileLoop(DoWhileLoopTree node,
                                       java.lang.Void p)

Specified by:

visitDoWhileLoop in interface TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitDoWhileLoop in class TreeScanner<java.lang.Void,java.lang.Void>

visitConditionalExpression

public java.lang.Void visitConditionalExpression(ConditionalExpressionTree node,
                                                 java.lang.Void p)

Specified by:

visitConditionalExpression in interface TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitConditionalExpression in class org.checkerframework.common.basetype.BaseTypeVisitor<NullnessAnnotatedTypeFactory>

checkExceptionParameter

protected void checkExceptionParameter(CatchTree node)

Overrides:

checkExceptionParameter in class org.checkerframework.common.basetype.BaseTypeVisitor<NullnessAnnotatedTypeFactory>