org.checkerframework.dataflow.util

Class PurityChecker.PurityCheckerHelper

java.lang.Object

com.sun.source.util.SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

org.checkerframework.dataflow.util.PurityChecker.PurityCheckerHelper

All Implemented Interfaces:

TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Enclosing class:

PurityChecker

protected static class PurityChecker.PurityCheckerHelper
extends SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Helper class to keep PurityChecker's interface clean. The implementation is heavily based on TreeScanner, but some parts of the AST are skipped (such as types or modifiers). Furthermore, scanning works differently in that the input parameter (usually named p) gets "threaded through", instead of using reduce.

Field Summary

Fields

Modifier and Type	Field and Description
protected AnnotationProvider	annoProvider
protected @Nullable List<Element>	methodParameter

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

DEFAULT_VALUE

Constructor Summary

Constructors

Constructor and Description
PurityCheckerHelper(AnnotationProvider annoProvider, boolean assumeSideEffectFree)

Method Summary

Modifier and Type	Method and Description
protected PurityChecker.PurityResult	assignmentCheck(PurityChecker.PurityResult p, ExpressionTree variable)
protected PurityChecker.PurityResult	defaultAction(Tree node, PurityChecker.PurityResult p)
protected boolean	isLocalVariable(ExpressionTree variable)
PurityChecker.PurityResult	scan(Iterable<? extends Tree> nodes, PurityChecker.PurityResult p) Scan a list of nodes.
PurityChecker.PurityResult	scan(Tree node, PurityChecker.PurityResult p) Scan a single node.
PurityChecker.PurityResult	visitArrayAccess(ArrayAccessTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitAssert(AssertTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitAssignment(AssignmentTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitBinary(BinaryTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitBlock(BlockTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitBreak(BreakTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitCase(CaseTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitCatch(CatchTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitClass(ClassTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitCompoundAssignment(CompoundAssignmentTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitConditionalExpression(ConditionalExpressionTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitContinue(ContinueTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitDoWhileLoop(DoWhileLoopTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitEmptyStatement(EmptyStatementTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitEnhancedForLoop(EnhancedForLoopTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitExpressionStatement(ExpressionStatementTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitForLoop(ForLoopTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitIdentifier(IdentifierTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitIf(IfTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitInstanceOf(InstanceOfTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitLabeledStatement(LabeledStatementTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitLambdaExpression(LambdaExpressionTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitLiteral(LiteralTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitMemberReference(MemberReferenceTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitMemberSelect(MemberSelectTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitMethodInvocation(MethodInvocationTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitNewArray(NewArrayTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitNewClass(NewClassTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitParenthesized(ParenthesizedTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitReturn(ReturnTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitSwitch(SwitchTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitSynchronized(SynchronizedTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitThrow(ThrowTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitTry(TryTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitTypeCast(TypeCastTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitUnary(UnaryTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitVariable(VariableTree node, PurityChecker.PurityResult p)
PurityChecker.PurityResult	visitWhileLoop(WhileLoopTree node, PurityChecker.PurityResult p)

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

visit, visit, visitAnnotatedType, visitAnnotation, visitArrayType, visitCompilationUnit, visitErroneous, visitImport, visitIntersectionType, visitMethod, visitModifiers, visitOther, visitParameterizedType, visitPrimitiveType, visitTypeParameter, visitUnionType, visitWildcard

Methods inherited from class java.lang.Object

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

Field Detail

annoProvider

protected final AnnotationProvider annoProvider

methodParameter

protected @Nullable List<Element> methodParameter

Constructor Detail

PurityCheckerHelper

public PurityCheckerHelper(AnnotationProvider annoProvider,
                           boolean assumeSideEffectFree)

Method Detail

scan

public PurityChecker.PurityResult scan(Tree node,
                                       PurityChecker.PurityResult p)

Scan a single node.

scan

public PurityChecker.PurityResult scan(Iterable<? extends Tree> nodes,
                                       PurityChecker.PurityResult p)

Scan a list of nodes.

defaultAction

protected PurityChecker.PurityResult defaultAction(Tree node,
                                                   PurityChecker.PurityResult p)

Overrides:

defaultAction in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitClass

public PurityChecker.PurityResult visitClass(ClassTree node,
                                             PurityChecker.PurityResult p)

Specified by:

visitClass in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitClass in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitVariable

public PurityChecker.PurityResult visitVariable(VariableTree node,
                                                PurityChecker.PurityResult p)

Specified by:

visitVariable in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitVariable in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitEmptyStatement

public PurityChecker.PurityResult visitEmptyStatement(EmptyStatementTree node,
                                                      PurityChecker.PurityResult p)

Specified by:

visitEmptyStatement in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitEmptyStatement in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitBlock

public PurityChecker.PurityResult visitBlock(BlockTree node,
                                             PurityChecker.PurityResult p)

Specified by:

visitBlock in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitBlock in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitDoWhileLoop

public PurityChecker.PurityResult visitDoWhileLoop(DoWhileLoopTree node,
                                                   PurityChecker.PurityResult p)

Specified by:

visitDoWhileLoop in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitDoWhileLoop in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitWhileLoop

public PurityChecker.PurityResult visitWhileLoop(WhileLoopTree node,
                                                 PurityChecker.PurityResult p)

Specified by:

visitWhileLoop in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitWhileLoop in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitForLoop

public PurityChecker.PurityResult visitForLoop(ForLoopTree node,
                                               PurityChecker.PurityResult p)

Specified by:

visitForLoop in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitForLoop in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitEnhancedForLoop

public PurityChecker.PurityResult visitEnhancedForLoop(EnhancedForLoopTree node,
                                                       PurityChecker.PurityResult p)

Specified by:

visitEnhancedForLoop in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitEnhancedForLoop in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitLabeledStatement

public PurityChecker.PurityResult visitLabeledStatement(LabeledStatementTree node,
                                                        PurityChecker.PurityResult p)

Specified by:

visitLabeledStatement in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitLabeledStatement in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitSwitch

public PurityChecker.PurityResult visitSwitch(SwitchTree node,
                                              PurityChecker.PurityResult p)

Specified by:

visitSwitch in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitSwitch in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitCase

public PurityChecker.PurityResult visitCase(CaseTree node,
                                            PurityChecker.PurityResult p)

Specified by:

visitCase in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitCase in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitSynchronized

public PurityChecker.PurityResult visitSynchronized(SynchronizedTree node,
                                                    PurityChecker.PurityResult p)

Specified by:

visitSynchronized in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitSynchronized in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitTry

public PurityChecker.PurityResult visitTry(TryTree node,
                                           PurityChecker.PurityResult p)

Specified by:

visitTry in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitTry in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitCatch

public PurityChecker.PurityResult visitCatch(CatchTree node,
                                             PurityChecker.PurityResult p)

Specified by:

visitCatch in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitCatch in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitConditionalExpression

public PurityChecker.PurityResult visitConditionalExpression(ConditionalExpressionTree node,
                                                             PurityChecker.PurityResult p)

Specified by:

visitConditionalExpression in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitConditionalExpression in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitIf

public PurityChecker.PurityResult visitIf(IfTree node,
                                          PurityChecker.PurityResult p)

Specified by:

visitIf in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitIf in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitExpressionStatement

public PurityChecker.PurityResult visitExpressionStatement(ExpressionStatementTree node,
                                                           PurityChecker.PurityResult p)

Specified by:

visitExpressionStatement in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitExpressionStatement in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitBreak

public PurityChecker.PurityResult visitBreak(BreakTree node,
                                             PurityChecker.PurityResult p)

Specified by:

visitBreak in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitBreak in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitContinue

public PurityChecker.PurityResult visitContinue(ContinueTree node,
                                                PurityChecker.PurityResult p)

Specified by:

visitContinue in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitContinue in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitReturn

public PurityChecker.PurityResult visitReturn(ReturnTree node,
                                              PurityChecker.PurityResult p)

Specified by:

visitReturn in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitReturn in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitThrow

public PurityChecker.PurityResult visitThrow(ThrowTree node,
                                             PurityChecker.PurityResult p)

Specified by:

visitThrow in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitThrow in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitAssert

public PurityChecker.PurityResult visitAssert(AssertTree node,
                                              PurityChecker.PurityResult p)

Specified by:

visitAssert in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitAssert in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitMethodInvocation

public PurityChecker.PurityResult visitMethodInvocation(MethodInvocationTree node,
                                                        PurityChecker.PurityResult p)

Specified by:

visitMethodInvocation in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitMethodInvocation in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitNewClass

public PurityChecker.PurityResult visitNewClass(NewClassTree node,
                                                PurityChecker.PurityResult p)

Specified by:

visitNewClass in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitNewClass in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitNewArray

public PurityChecker.PurityResult visitNewArray(NewArrayTree node,
                                                PurityChecker.PurityResult p)

Specified by:

visitNewArray in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitNewArray in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitLambdaExpression

public PurityChecker.PurityResult visitLambdaExpression(LambdaExpressionTree node,
                                                        PurityChecker.PurityResult p)

Specified by:

visitLambdaExpression in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitLambdaExpression in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitParenthesized

public PurityChecker.PurityResult visitParenthesized(ParenthesizedTree node,
                                                     PurityChecker.PurityResult p)

Specified by:

visitParenthesized in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitParenthesized in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitAssignment

public PurityChecker.PurityResult visitAssignment(AssignmentTree node,
                                                  PurityChecker.PurityResult p)

Specified by:

visitAssignment in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitAssignment in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

assignmentCheck

protected PurityChecker.PurityResult assignmentCheck(PurityChecker.PurityResult p,
                                                     ExpressionTree variable)

isLocalVariable

protected boolean isLocalVariable(ExpressionTree variable)

visitCompoundAssignment

public PurityChecker.PurityResult visitCompoundAssignment(CompoundAssignmentTree node,
                                                          PurityChecker.PurityResult p)

Specified by:

visitCompoundAssignment in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitCompoundAssignment in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitUnary

public PurityChecker.PurityResult visitUnary(UnaryTree node,
                                             PurityChecker.PurityResult p)

Specified by:

visitUnary in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitUnary in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitBinary

public PurityChecker.PurityResult visitBinary(BinaryTree node,
                                              PurityChecker.PurityResult p)

Specified by:

visitBinary in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitBinary in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitTypeCast

public PurityChecker.PurityResult visitTypeCast(TypeCastTree node,
                                                PurityChecker.PurityResult p)

Specified by:

visitTypeCast in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitTypeCast in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitInstanceOf

public PurityChecker.PurityResult visitInstanceOf(InstanceOfTree node,
                                                  PurityChecker.PurityResult p)

Specified by:

visitInstanceOf in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitInstanceOf in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitArrayAccess

public PurityChecker.PurityResult visitArrayAccess(ArrayAccessTree node,
                                                   PurityChecker.PurityResult p)

Specified by:

visitArrayAccess in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitArrayAccess in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitMemberSelect

public PurityChecker.PurityResult visitMemberSelect(MemberSelectTree node,
                                                    PurityChecker.PurityResult p)

Specified by:

visitMemberSelect in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitMemberSelect in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitMemberReference

public PurityChecker.PurityResult visitMemberReference(MemberReferenceTree node,
                                                       PurityChecker.PurityResult p)

Specified by:

visitMemberReference in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitMemberReference in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitIdentifier

public PurityChecker.PurityResult visitIdentifier(IdentifierTree node,
                                                  PurityChecker.PurityResult p)

Specified by:

visitIdentifier in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitIdentifier in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

visitLiteral

public PurityChecker.PurityResult visitLiteral(LiteralTree node,
                                               PurityChecker.PurityResult p)

Specified by:

visitLiteral in interface TreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>

Overrides:

visitLiteral in class SimpleTreeVisitor<PurityChecker.PurityResult,PurityChecker.PurityResult>