Class PropertyKeyAnnotatedTypeFactory.KeyLookupTreeAnnotator

  • All Implemented Interfaces:
    com.sun.source.tree.TreeVisitor<java.lang.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 com.sun.source.util.SimpleTreeVisitor

        DEFAULT_VALUE
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Void visitBinary​(com.sun.source.tree.BinaryTree tree, AnnotatedTypeMirror type)
      When overriding this method, getAnnotatedType on the left and right operands should only be called when absolutely necessary.
      java.lang.Void visitCompoundAssignment​(com.sun.source.tree.CompoundAssignmentTree tree, AnnotatedTypeMirror type)  
      java.lang.Void visitLiteral​(com.sun.source.tree.LiteralTree tree, AnnotatedTypeMirror type)  
      • 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,
                                      java.lang.Class<? extends java.lang.annotation.Annotation> annot)
    • Method Detail

      • visitLiteral

        public java.lang.Void visitLiteral​(com.sun.source.tree.LiteralTree tree,
                                           AnnotatedTypeMirror type)
        Specified by:
        visitLiteral in interface com.sun.source.tree.TreeVisitor<java.lang.Void,​AnnotatedTypeMirror>
        Overrides:
        visitLiteral in class com.sun.source.util.SimpleTreeVisitor<java.lang.Void,​AnnotatedTypeMirror>
      • visitBinary

        public java.lang.Void visitBinary​(com.sun.source.tree.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.)

        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 com.sun.source.tree.TreeVisitor<java.lang.Void,​AnnotatedTypeMirror>
        Overrides:
        visitBinary in class TreeAnnotator
      • visitCompoundAssignment

        public java.lang.Void visitCompoundAssignment​(com.sun.source.tree.CompoundAssignmentTree tree,
                                                      AnnotatedTypeMirror type)
        Specified by:
        visitCompoundAssignment in interface com.sun.source.tree.TreeVisitor<java.lang.Void,​AnnotatedTypeMirror>
        Overrides:
        visitCompoundAssignment in class com.sun.source.util.SimpleTreeVisitor<java.lang.Void,​AnnotatedTypeMirror>