checkers.nullness

Class NullnessFlowConditions

java.lang.Object

com.sun.source.util.SimpleTreeVisitor<@Nullable Void,@Nullable Void>

checkers.nullness.NullnessFlowConditions

All Implemented Interfaces:

TreeVisitor<@Nullable Void,@Nullable Void>

public class NullnessFlowConditions
extends SimpleTreeVisitor<@Nullable Void,@Nullable Void>

A utility class used by a NonNull-specific flow-sensitive qualifier inference to determine nullness in conditionally-executed scopes.

This class is implemented as a visitor; it should only be initially invoked on the conditions of e.g. if statements. TODO: extract any common behavior to a FlowConditions superclass. TODO: can we benefit from using FlowState?

Field Summary

Fields

Modifier and Type	Field and Description
protected PrintStream	debug
protected checkers.nullness.NullnessFlow	nullnessFlow
protected NullnessAnnotatedTypeFactory	typefactory

Fields inherited from class com.sun.source.util.SimpleTreeVisitor

DEFAULT_VALUE

Constructor Summary

Constructors

Constructor and Description
NullnessFlowConditions(NullnessAnnotatedTypeFactory tf, checkers.nullness.NullnessFlow nf, PrintStream debug)

Method Summary

Methods

Modifier and Type	Method and Description
@ReadOnly Set<@Nullable Element>	getExcludes()
@ReadOnly List<VariableElement>	getExplicitNonnullElements()
@ReadOnly List<VariableElement>	getExplicitNullableElements()
@ReadOnly Set<VariableElement>	getNonnullElements()
@ReadOnly List<@ReadOnly String>	getNonnullExpressions()
@ReadOnly Set<VariableElement>	getNullableElements()
@ReadOnly List<@ReadOnly String>	getNullableExpressions()
@ReadOnly Map<@Nullable Tree,Set<@Nullable AnnotationMirror>>	getTreeResults()
boolean	isNullPolyNull()
@Nullable Void	visitAssignment(AssignmentTree node, @Nullable Void p)
@Nullable Void	visitBinary(BinaryTree node, @Nullable Void p)
@Nullable Void	visitConditionalExpression(ConditionalExpressionTree node, @Nullable Void p)
@Nullable Void	visitIdentifier(IdentifierTree node, @Nullable Void p)
@Nullable Void	visitInstanceOf(InstanceOfTree node, @Nullable Void p)
@Nullable Void	visitMemberSelect(MemberSelectTree node, @Nullable Void p)
@Nullable Void	visitMethodInvocation(MethodInvocationTree node, @Nullable Void p)
@Nullable Void	visitParenthesized(ParenthesizedTree node, @Nullable Void p)
@Nullable Void	visitUnary(UnaryTree node, @Nullable Void p)

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

defaultAction, visit, visit, visitAnnotatedType, visitAnnotation, visitArrayAccess, visitArrayType, visitAssert, visitBlock, visitBreak, visitCase, visitCatch, visitClass, visitCompilationUnit, visitCompoundAssignment, visitContinue, visitDoWhileLoop, visitEmptyStatement, visitEnhancedForLoop, visitErroneous, visitExpressionStatement, visitForLoop, visitIf, visitImport, visitLabeledStatement, visitLambdaExpression, visitLiteral, visitMemberReference, visitMethod, visitModifiers, visitNewArray, visitNewClass, visitOther, visitParameterizedType, visitPrimitiveType, visitReturn, visitSwitch, visitSynchronized, visitThrow, visitTry, visitTypeCast, visitTypeParameter, visitUnionType, visitVariable, visitWhileLoop, visitWildcard

Methods inherited from class java.lang.Object

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

Field Detail

typefactory

protected final NullnessAnnotatedTypeFactory typefactory

nullnessFlow

protected final checkers.nullness.NullnessFlow nullnessFlow

debug

protected final PrintStream debug

Constructor Detail

NullnessFlowConditions

public NullnessFlowConditions(NullnessAnnotatedTypeFactory tf,
                      checkers.nullness.NullnessFlow nf,
                      PrintStream debug)

Method Detail

getNonnullElements

public @ReadOnly Set<VariableElement> getNonnullElements()

Returns:

the elements that this analysis has determined to be NonNull when the condition being analyzed is true

getNullableElements

public @ReadOnly Set<VariableElement> getNullableElements()

Returns:

the elements that this analysis has determined to be Nullable when the condition being analyzed is true

getNonnullExpressions

public @ReadOnly List<@ReadOnly String> getNonnullExpressions()

getNullableExpressions

public @ReadOnly List<@ReadOnly String> getNullableExpressions()

getExplicitNonnullElements

public @ReadOnly List<VariableElement> getExplicitNonnullElements()

getExplicitNullableElements

public @ReadOnly List<VariableElement> getExplicitNullableElements()

isNullPolyNull

public boolean isNullPolyNull()

getExcludes

public @ReadOnly Set<@Nullable Element> getExcludes()

getTreeResults

public @ReadOnly Map<@Nullable Tree,Set<@Nullable AnnotationMirror>> getTreeResults()

visitUnary

public @Nullable Void visitUnary(UnaryTree node,
                        @Nullable Void p)

Specified by:

visitUnary in interface TreeVisitor<@Nullable Void,@Nullable Void>

Overrides:

visitUnary in class SimpleTreeVisitor<@Nullable Void,@Nullable Void>

visitInstanceOf

public @Nullable Void visitInstanceOf(InstanceOfTree node,
                             @Nullable Void p)

Specified by:

visitInstanceOf in interface TreeVisitor<@Nullable Void,@Nullable Void>

Overrides:

visitInstanceOf in class SimpleTreeVisitor<@Nullable Void,@Nullable Void>

visitConditionalExpression

public @Nullable Void visitConditionalExpression(ConditionalExpressionTree node,
                                        @Nullable Void p)

Specified by:

visitConditionalExpression in interface TreeVisitor<@Nullable Void,@Nullable Void>

Overrides:

visitConditionalExpression in class SimpleTreeVisitor<@Nullable Void,@Nullable Void>

visitBinary

public @Nullable Void visitBinary(BinaryTree node,
                         @Nullable Void p)

Specified by:

visitBinary in interface TreeVisitor<@Nullable Void,@Nullable Void>

Overrides:

visitBinary in class SimpleTreeVisitor<@Nullable Void,@Nullable Void>

visitIdentifier

public @Nullable Void visitIdentifier(IdentifierTree node,
                             @Nullable Void p)

Specified by:

visitIdentifier in interface TreeVisitor<@Nullable Void,@Nullable Void>

Overrides:

visitIdentifier in class SimpleTreeVisitor<@Nullable Void,@Nullable Void>

visitMemberSelect

public @Nullable Void visitMemberSelect(MemberSelectTree node,
                               @Nullable Void p)

Specified by:

visitMemberSelect in interface TreeVisitor<@Nullable Void,@Nullable Void>

Overrides:

visitMemberSelect in class SimpleTreeVisitor<@Nullable Void,@Nullable Void>

visitParenthesized

public @Nullable Void visitParenthesized(ParenthesizedTree node,
                                @Nullable Void p)

Specified by:

visitParenthesized in interface TreeVisitor<@Nullable Void,@Nullable Void>

Overrides:

visitParenthesized in class SimpleTreeVisitor<@Nullable Void,@Nullable Void>

visitAssignment

public @Nullable Void visitAssignment(AssignmentTree node,
                             @Nullable Void p)

Specified by:

visitAssignment in interface TreeVisitor<@Nullable Void,@Nullable Void>

Overrides:

visitAssignment in class SimpleTreeVisitor<@Nullable Void,@Nullable Void>

visitMethodInvocation

public @Nullable Void visitMethodInvocation(MethodInvocationTree node,
                                   @Nullable Void p)

Specified by:

visitMethodInvocation in interface TreeVisitor<@Nullable Void,@Nullable Void>

Overrides:

visitMethodInvocation in class SimpleTreeVisitor<@Nullable Void,@Nullable Void>