Package org.checkerframework.dataflow.util

Class PurityChecker.PurityCheckerHelper

java.lang.Object

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

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

org.checkerframework.dataflow.util.PurityChecker.PurityCheckerHelper

All Implemented Interfaces:

TreeVisitor<Void,Void>

Enclosing class:

PurityChecker

protected static class PurityChecker.PurityCheckerHelper
extends TreePathScanner<Void,Void>

Helper class to keep PurityChecker's interface clean.

The scanner is run on a single statement, not on a class or method.

Field Summary

Fields

Modifier and Type	Field	Description
protected final AnnotationProvider	annoProvider	The annotation provider (typically an AnnotatedTypeFactory).

Constructor Summary

Constructors

Constructor	Description
PurityCheckerHelper(AnnotationProvider annoProvider, boolean assumeSideEffectFree, boolean assumeDeterministic, boolean assumePureGetters)	Create a PurityCheckerHelper.

Method Summary

Modifier and Type	Method	Description
protected void	assignmentCheck(ExpressionTree variable)	Check whether variable is permitted on the left-hand-side of an assignment.
protected boolean	isLocalVariable(ExpressionTree variable)	Checks if the argument is a local variable.
Void	visitAssignment(AssignmentTree tree, Void ignore)
Void	visitCatch(CatchTree tree, Void ignore)
Void	visitCompoundAssignment(CompoundAssignmentTree tree, Void ignore)
Void	visitMethodInvocation(MethodInvocationTree tree, Void ignore)
Void	visitNewClass(NewClassTree tree, Void ignore)
Void	visitUnary(UnaryTree tree, Void ignore)

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

getCurrentPath, scan, scan

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

reduce, scan, visitAnnotatedType, visitAnnotation, visitArrayAccess, visitArrayType, visitAssert, visitBinary, visitBindingPattern, visitBlock, visitBreak, visitCase, visitClass, visitCompilationUnit, visitConditionalExpression, visitContinue, visitDefaultCaseLabel, visitDoWhileLoop, visitEmptyStatement, visitEnhancedForLoop, visitErroneous, visitExports, visitExpressionStatement, visitForLoop, visitGuardedPattern, visitIdentifier, visitIf, visitImport, visitInstanceOf, visitIntersectionType, visitLabeledStatement, visitLambdaExpression, visitLiteral, visitMemberReference, visitMemberSelect, visitMethod, visitModifiers, visitModule, visitNewArray, visitOpens, visitOther, visitPackage, visitParameterizedType, visitParenthesized, visitParenthesizedPattern, visitPrimitiveType, visitProvides, visitRequires, visitReturn, visitSwitch, visitSwitchExpression, visitSynchronized, visitThrow, visitTry, visitTypeCast, visitTypeParameter, visitUnionType, visitUses, visitVariable, visitWhileLoop, visitWildcard, visitYield

Methods inherited from class java.lang.Object

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

Field Details

annoProvider

protected final AnnotationProvider annoProvider

The annotation provider (typically an AnnotatedTypeFactory).

Constructor Details

PurityCheckerHelper

public PurityCheckerHelper(AnnotationProvider annoProvider,
 boolean assumeSideEffectFree,
 boolean assumeDeterministic,
 boolean assumePureGetters)

Create a PurityCheckerHelper.

Parameters:

annoProvider - the annotation provider

assumeSideEffectFree - true if all methods should be assumed to be @SideEffectFree

assumeDeterministic - true if all methods should be assumed to be @Deterministic

assumePureGetters - true if getter methods should be assumed to be @Pure

Method Details

visitCatch

public Void visitCatch(CatchTree tree,
 Void ignore)

Specified by:

visitCatch in interface TreeVisitor<Void,Void>

Overrides:

visitCatch in class TreeScanner<Void,Void>

visitMethodInvocation

public Void visitMethodInvocation(MethodInvocationTree tree,
 Void ignore)

Specified by:

visitMethodInvocation in interface TreeVisitor<Void,Void>

Overrides:

visitMethodInvocation in class TreeScanner<Void,Void>

visitNewClass

public Void visitNewClass(NewClassTree tree,
 Void ignore)

Specified by:

visitNewClass in interface TreeVisitor<Void,Void>

Overrides:

visitNewClass in class TreeScanner<Void,Void>

visitAssignment

public Void visitAssignment(AssignmentTree tree,
 Void ignore)

Specified by:

visitAssignment in interface TreeVisitor<Void,Void>

Overrides:

visitAssignment in class TreeScanner<Void,Void>

visitUnary

public Void visitUnary(UnaryTree tree,
 Void ignore)

Specified by:

visitUnary in interface TreeVisitor<Void,Void>

Overrides:

visitUnary in class TreeScanner<Void,Void>

assignmentCheck

protected void assignmentCheck(ExpressionTree variable)

Check whether variable is permitted on the left-hand-side of an assignment.

Parameters:

variable - the lhs to check

isLocalVariable

protected boolean isLocalVariable(ExpressionTree variable)

Checks if the argument is a local variable.

Parameters:

variable - the tree to check

Returns:

true if the argument is a local variable

visitCompoundAssignment

public Void visitCompoundAssignment(CompoundAssignmentTree tree,
 Void ignore)

Specified by:

visitCompoundAssignment in interface TreeVisitor<Void,Void>

Overrides:

visitCompoundAssignment in class TreeScanner<Void,Void>