Package org.checkerframework.checker.lock

Class LockTreeAnnotator

java.lang.Object

com.sun.source.util.SimpleTreeVisitor<Void,AnnotatedTypeMirror>

org.checkerframework.framework.type.treeannotator.TreeAnnotator

org.checkerframework.checker.lock.LockTreeAnnotator

All Implemented Interfaces:

TreeVisitor<Void,AnnotatedTypeMirror>

public class LockTreeAnnotator
extends TreeAnnotator

A TreeAnnotator implementation to apply special type introduction rules to string concatenations, binary comparisons, and new array instantiations.

Field Summary

Fields inherited from class org.checkerframework.framework.type.treeannotator.TreeAnnotator

atypeFactory

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

DEFAULT_VALUE

Constructor Summary

Constructors

Constructor	Description
LockTreeAnnotator(AnnotatedTypeFactory atypeFactory)

Method Summary

Modifier and Type	Method	Description
Void	visitBinary(BinaryTree tree, AnnotatedTypeMirror type)	When overriding this method, getAnnotatedType on the left and right operands should only be called when absolutely necessary.
Void	visitCompoundAssignment(CompoundAssignmentTree tree, AnnotatedTypeMirror type)
Void	visitNewArray(NewArrayTree tree, AnnotatedTypeMirror type)

Methods inherited from class org.checkerframework.framework.type.treeannotator.TreeAnnotator

log, visitMethod

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

LockTreeAnnotator

public LockTreeAnnotator(AnnotatedTypeFactory atypeFactory)

Method Details

visitBinary

public Void visitBinary(BinaryTree tree,
 AnnotatedTypeMirror type)

Description copied from class: TreeAnnotator

When overriding this method, getAnnotatedType on the left and right operands should only be called when absolutely necessary. Otherwise, the checker will be very slow on heavily nested binary trees. (For example, a + b + c + d + e + f + g + h.)

One approach is to perform work in this method only if type.hasPrimaryAnnotationInHierarchy(...) returns false.

If a checker's performance is still too slow:

• Compute the types of binary trees in a subclass of CFTransfer; look up the value in the store rather than the AnnotatedTypeFactory.
• This method (TreeAnnotator.visitBinary) should annotate binary trees with top so that the type applied in the transfer is always a subtype of the type the AnnotatedTypeFactory computes.

Specified by:

visitBinary in interface TreeVisitor<Void,AnnotatedTypeMirror>

Overrides:

visitBinary in class TreeAnnotator

visitCompoundAssignment

public Void visitCompoundAssignment(CompoundAssignmentTree tree,
 AnnotatedTypeMirror type)

Specified by:

visitCompoundAssignment in interface TreeVisitor<Void,AnnotatedTypeMirror>

Overrides:

visitCompoundAssignment in class SimpleTreeVisitor<Void,AnnotatedTypeMirror>

visitNewArray

public Void visitNewArray(NewArrayTree tree,
 AnnotatedTypeMirror type)

Specified by:

visitNewArray in interface TreeVisitor<Void,AnnotatedTypeMirror>

Overrides:

visitNewArray in class SimpleTreeVisitor<Void,AnnotatedTypeMirror>