org.checkerframework.checker.propkey

Class PropertyKeyAnnotatedTypeFactory.KeyLookupTreeAnnotator

java.lang.Object

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

org.checkerframework.framework.type.treeannotator.TreeAnnotator

org.checkerframework.checker.propkey.PropertyKeyAnnotatedTypeFactory.KeyLookupTreeAnnotator

All Implemented Interfaces:

TreeVisitor<Void,AnnotatedTypeMirror>

Enclosing class:

PropertyKeyAnnotatedTypeFactory

protected class PropertyKeyAnnotatedTypeFactory.KeyLookupTreeAnnotator
extends TreeAnnotator

This TreeAnnotator checks for every String literal whether it is included in the lookup keys. If it is, the given annotation is added to the literal; otherwise, nothing happens. Subclasses of this AnnotatedTypeFactory can directly reuse this class and use a different annotation as parameter.

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 and Description
KeyLookupTreeAnnotator(BaseAnnotatedTypeFactory atf, Class<? extends Annotation> annot)

Method Summary

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

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

visitMethod

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyLookupTreeAnnotator

public KeyLookupTreeAnnotator(BaseAnnotatedTypeFactory atf,
                              Class<? extends Annotation> annot)

Method Detail

visitLiteral

public Void visitLiteral(LiteralTree tree,
                         AnnotatedTypeMirror type)

Specified by:

visitLiteral in interface TreeVisitor<Void,AnnotatedTypeMirror>

Overrides:

visitLiteral in class SimpleTreeVisitor<Void,AnnotatedTypeMirror>

visitBinary

public Void visitBinary(BinaryTree node,
                        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.)

If a checker's performance is still too slow, the types of binary trees could be computed in a subclass of CFTransfer. When computing the types in a transfer, look up the value in the store rather than the AnnotatedTypeFactory. Then this method 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 node,
                                    AnnotatedTypeMirror type)

Specified by:

visitCompoundAssignment in interface TreeVisitor<Void,AnnotatedTypeMirror>

Overrides:

visitCompoundAssignment in class SimpleTreeVisitor<Void,AnnotatedTypeMirror>