checkers.flow

Class DefaultFlow<ST extends DefaultFlowState>

java.lang.Object

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

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

checkers.flow.AbstractFlow<ST>

checkers.flow.DefaultFlow<ST>

Type Parameters:

ST - the flow state subclass that should be used. If DefaultFlow is instantiated directly the type argument has to be DefaultFlowState. In other cases, method createFlowState has to be overridden correctly!

All Implemented Interfaces:

Flow, TreeVisitor<@Nullable Void,@Nullable Void>

Direct Known Subclasses:

RegexFlow

public class DefaultFlow<ST extends DefaultFlowState>
extends AbstractFlow<ST>

The default implementation of the flow-sensitive type inference.

Field Summary

Fields inherited from class checkers.flow.AbstractFlow

alive, annoRelations, atypes, checker, debug, factory, flowResults, flowState, flowState_whenFalse, flowState_whenTrue, root

Constructor Summary

Constructors

Constructor and Description
DefaultFlow(BaseTypeChecker checker, @Nullable CompilationUnitTree root, Set<@Nullable AnnotationMirror> annotations, AnnotatedTypeFactory factory)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	clearOnCall(@Nullable MethodTree enclMeth, @NonNull ExecutableElement method) Clear whatever part of the state that gets invalidated by invoking the method.
protected ST	createFlowState(Set<@Nullable AnnotationMirror> annotations) Create the correct instance of FlowState.
protected void	newVar(VariableTree tree) Registers a new variable for flow tracking.
protected void	propagate(@Nullable Tree lhs, ExpressionTree rhs) Moves bits as assignments are made.
protected void	recordBitsImps(@Nullable Tree tree, @Nullable Element elt)

Methods inherited from class checkers.flow.AbstractFlow

addFlowResult, checkArguments, containsKey, copyState, inferFromAssert, isNonFinalField, recordBits, removeFlowResult, scan, scan, scanCond, scanDef, scanExpr, scanStat, scanStats, setDebug, test, varDefHasAnnotation, visitAnnotation, visitArrayAccess, visitAssert, visitAssignment, visitBlock, visitBreak, visitClass, visitCompoundAssignment, visitConditionalExpression, visitContinue, visitDoWhileLoop, visitEnhancedForLoop, visitForLoop, visitIdentifier, visitIf, visitImport, visitMemberSelect, visitMethod, visitMethodEndCallback, visitMethodInvocation, visitReturn, visitThrow, visitTry, visitTypeCast, visitVariable, visitWhileLoop

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

getCurrentPath, scan

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

reduce, scan, visitAnnotatedType, visitArrayType, visitBinary, visitCase, visitCatch, visitCompilationUnit, visitEmptyStatement, visitErroneous, visitExpressionStatement, visitInstanceOf, visitLabeledStatement, visitLambdaExpression, visitLiteral, visitMemberReference, visitModifiers, visitNewArray, visitNewClass, visitOther, visitParameterizedType, visitParenthesized, visitPrimitiveType, visitSwitch, visitSynchronized, visitTypeParameter, visitUnary, visitUnionType, visitWildcard

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultFlow

public DefaultFlow(BaseTypeChecker checker,
           @Nullable CompilationUnitTree root,
           Set<@Nullable AnnotationMirror> annotations,
           AnnotatedTypeFactory factory)

Method Detail

createFlowState

protected ST createFlowState(Set<@Nullable AnnotationMirror> annotations)

Description copied from class: AbstractFlow

Create the correct instance of FlowState.

Specified by:

createFlowState in class AbstractFlow<ST extends DefaultFlowState>

Parameters:

annotations - The annotations that can be inferred.

Returns:

A new instance of the FlowState to use.

newVar

protected void newVar(VariableTree tree)

Description copied from class: AbstractFlow

Registers a new variable for flow tracking.

Specified by:

newVar in class AbstractFlow<ST extends DefaultFlowState>

Parameters:

tree - the variable to register

propagate

protected void propagate(@Nullable Tree lhs,
             ExpressionTree rhs)

Description copied from class: AbstractFlow

Moves bits as assignments are made.

If only type information (and not a Tree) is available, use AbstractFlow.propagateFromType(Tree, AnnotatedTypeMirror) instead.

Specified by:

propagate in class AbstractFlow<ST extends DefaultFlowState>

Parameters:

lhs - the left-hand side of the assignment

rhs - the right-hand side of the assignment

recordBitsImps

protected void recordBitsImps(@Nullable Tree tree,
                  @Nullable Element elt)

Specified by:

recordBitsImps in class AbstractFlow<ST extends DefaultFlowState>

clearOnCall

protected void clearOnCall(@Nullable MethodTree enclMeth,
               @NonNull ExecutableElement method)

Description copied from class: AbstractFlow

Clear whatever part of the state that gets invalidated by invoking the method.

Specified by:

clearOnCall in class AbstractFlow<ST extends DefaultFlowState>

Parameters:

enclMeth - The method within which "method" is called. Might be null if the invocation is in a field initializer.

method - The invoked method.