checkers.types

Class TreeAnnotator

java.lang.Object

com.sun.source.util.SimpleTreeVisitor<@Nullable Void,@Mutable AnnotatedTypeMirror>

checkers.types.TreeAnnotator

All Implemented Interfaces:

TreeVisitor<@Nullable Void,@Mutable AnnotatedTypeMirror>

Direct Known Subclasses:

PropertyKeyAnnotatedTypeFactory.KeyLookupTreeAnnotator

public class TreeAnnotator
extends SimpleTreeVisitor<@Nullable Void,@Mutable AnnotatedTypeMirror>

Adds annotations to a type based on the contents of a tree. By default, this class honors the ImplicitFor annotation and applies implicit annotations specified by ImplicitFor for any tree whose visitor is not overridden or does not call super; it is designed to be invoked from AnnotatedTypeFactory.annotateImplicit(Element, AnnotatedTypeMirror) and AnnotatedTypeFactory.annotateImplicit(Tree, AnnotatedTypeMirror).

TreeAnnotator does not traverse trees deeply by default. This class takes care of three of the attributes of ImplicitFor; the others are handled in TypeAnnotator. TODO: we currently don't check that any attribute is set, that is, a qualifier could be annotated as @ImplicitFor(), which might be misleading.

See Also:

TypeAnnotator

Field Summary

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

DEFAULT_VALUE

Constructor Summary

Constructors

Constructor and Description
TreeAnnotator(BaseTypeChecker checker, AnnotatedTypeFactory typeFactory) Creates a TypeAnnotator from the given checker, using that checker's TypeQualifiers annotation to determine the annotations that are in the type hierarchy.

Method Summary

Methods

Modifier and Type	Method and Description
void	addStringPattern(@ReadOnly String pattern, @Nullable AnnotationMirror theQual)
void	addTreeClass(Class<? extends @Nullable Tree> treeClass, @Nullable AnnotationMirror theQual)
void	addTreeKind(Tree.Kind treeKind, @Nullable AnnotationMirror theQual)
@Nullable Void	defaultAction(@Nullable Tree tree, @Mutable AnnotatedTypeMirror type)
@Nullable Void	visitBinary(BinaryTree node, @Mutable AnnotatedTypeMirror type)
@Nullable Void	visitCompoundAssignment(CompoundAssignmentTree node, @Mutable AnnotatedTypeMirror type)
@Nullable Void	visitLiteral(LiteralTree tree, @Mutable AnnotatedTypeMirror type) Go through the string patterns and add the greatest lower bound of all matching patterns.
@Nullable Void	visitNewArray(NewArrayTree tree, @Mutable AnnotatedTypeMirror type)
@Nullable Void	visitTypeCast(TypeCastTree node, @Mutable AnnotatedTypeMirror type)
@Nullable Void	visitUnary(UnaryTree node, @Mutable AnnotatedTypeMirror type)

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

visit, visit, visitAnnotatedType, visitAnnotation, visitArrayAccess, visitArrayType, visitAssert, visitAssignment, visitBlock, visitBreak, visitCase, visitCatch, visitClass, visitCompilationUnit, visitConditionalExpression, visitContinue, visitDoWhileLoop, visitEmptyStatement, visitEnhancedForLoop, visitErroneous, visitExpressionStatement, visitForLoop, visitIdentifier, visitIf, visitImport, visitInstanceOf, visitLabeledStatement, visitLambdaExpression, visitMemberReference, visitMemberSelect, visitMethod, visitMethodInvocation, visitModifiers, visitNewClass, visitOther, visitParameterizedType, visitParenthesized, visitPrimitiveType, visitReturn, visitSwitch, visitSynchronized, visitThrow, visitTry, visitTypeParameter, visitUnionType, visitVariable, visitWhileLoop, visitWildcard

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeAnnotator

public TreeAnnotator(BaseTypeChecker checker,
             AnnotatedTypeFactory typeFactory)

Creates a TypeAnnotator from the given checker, using that checker's TypeQualifiers annotation to determine the annotations that are in the type hierarchy.

Parameters:

checker - the type checker to which this annotator belongs

Method Detail

addTreeClass

public void addTreeClass(Class<? extends @Nullable Tree> treeClass,
                @Nullable AnnotationMirror theQual)

addTreeKind

public void addTreeKind(Tree.Kind treeKind,
               @Nullable AnnotationMirror theQual)

addStringPattern

public void addStringPattern(@ReadOnly String pattern,
                    @Nullable AnnotationMirror theQual)

defaultAction

public @Nullable Void defaultAction(@Nullable Tree tree,
                           @Mutable AnnotatedTypeMirror type)

Overrides:

defaultAction in class SimpleTreeVisitor<@Nullable Void,@Mutable AnnotatedTypeMirror>

visitLiteral

public @Nullable Void visitLiteral(LiteralTree tree,
                          @Mutable AnnotatedTypeMirror type)

Go through the string patterns and add the greatest lower bound of all matching patterns.

Specified by:

visitLiteral in interface TreeVisitor<@Nullable Void,@Mutable AnnotatedTypeMirror>

Overrides:

visitLiteral in class SimpleTreeVisitor<@Nullable Void,@Mutable AnnotatedTypeMirror>

visitNewArray

public @Nullable Void visitNewArray(NewArrayTree tree,
                           @Mutable AnnotatedTypeMirror type)

Specified by:

visitNewArray in interface TreeVisitor<@Nullable Void,@Mutable AnnotatedTypeMirror>

Overrides:

visitNewArray in class SimpleTreeVisitor<@Nullable Void,@Mutable AnnotatedTypeMirror>

visitCompoundAssignment

public @Nullable Void visitCompoundAssignment(CompoundAssignmentTree node,
                                     @Mutable AnnotatedTypeMirror type)

Specified by:

visitCompoundAssignment in interface TreeVisitor<@Nullable Void,@Mutable AnnotatedTypeMirror>

Overrides:

visitCompoundAssignment in class SimpleTreeVisitor<@Nullable Void,@Mutable AnnotatedTypeMirror>

visitBinary

public @Nullable Void visitBinary(BinaryTree node,
                         @Mutable AnnotatedTypeMirror type)

Specified by:

visitBinary in interface TreeVisitor<@Nullable Void,@Mutable AnnotatedTypeMirror>

Overrides:

visitBinary in class SimpleTreeVisitor<@Nullable Void,@Mutable AnnotatedTypeMirror>

visitUnary

public @Nullable Void visitUnary(UnaryTree node,
                        @Mutable AnnotatedTypeMirror type)

Specified by:

visitUnary in interface TreeVisitor<@Nullable Void,@Mutable AnnotatedTypeMirror>

Overrides:

visitUnary in class SimpleTreeVisitor<@Nullable Void,@Mutable AnnotatedTypeMirror>

visitTypeCast

public @Nullable Void visitTypeCast(TypeCastTree node,
                           @Mutable AnnotatedTypeMirror type)

Specified by:

visitTypeCast in interface TreeVisitor<@Nullable Void,@Mutable AnnotatedTypeMirror>

Overrides:

visitTypeCast in class SimpleTreeVisitor<@Nullable Void,@Mutable AnnotatedTypeMirror>