org.checkerframework.framework.type.treeannotator

Class PropagationTreeAnnotator

java.lang.Object

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

org.checkerframework.framework.type.treeannotator.TreeAnnotator

org.checkerframework.framework.type.treeannotator.PropagationTreeAnnotator

All Implemented Interfaces:

com.sun.source.tree.TreeVisitor<java.lang.Void,AnnotatedTypeMirror>

Direct Known Subclasses:

NullnessAnnotatedTypeFactory.NullnessPropagationTreeAnnotator

public class PropagationTreeAnnotator
extends TreeAnnotator

PropagationTreeAnnotator adds qualifiers to types where the resulting type is a function of an input type, e.g. the result of a binary operation is a LUB of the type of expressions in the binary operation.

PropagationTreeAnnotator is generally run first by ListTreeAnnotator since the trees it handles are not usually targets of @DefaultFor.

PropagationTreeAnnotator does not traverse trees deeply by default.

See Also:

TreeAnnotator

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
PropagationTreeAnnotator(AnnotatedTypeFactory atypeFactory) Creates a PropagationTreeAnnotator for the given atypeFactory.

Method Summary

Modifier and Type	Method and Description
java.lang.Void	visitBinary(com.sun.source.tree.BinaryTree node, 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 node, AnnotatedTypeMirror type)
java.lang.Void	visitNewArray(com.sun.source.tree.NewArrayTree tree, AnnotatedTypeMirror type)
java.lang.Void	visitTypeCast(com.sun.source.tree.TypeCastTree node, AnnotatedTypeMirror type)
java.lang.Void	visitUnary(com.sun.source.tree.UnaryTree node, 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, visitLiteral, visitMemberReference, visitMemberSelect, visitMethodInvocation, visitModifiers, visitModule, visitNewClass, visitOpens, visitOther, visitPackage, visitParameterizedType, visitParenthesized, visitPrimitiveType, visitProvides, visitRequires, visitReturn, visitSwitch, visitSynchronized, visitThrow, visitTry, visitTypeParameter, 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

PropagationTreeAnnotator

public PropagationTreeAnnotator(AnnotatedTypeFactory atypeFactory)

Creates a PropagationTreeAnnotator for the given atypeFactory.

Method Detail

visitNewArray

public java.lang.Void visitNewArray(com.sun.source.tree.NewArrayTree tree,
                                    AnnotatedTypeMirror type)

Specified by:

visitNewArray in interface com.sun.source.tree.TreeVisitor<java.lang.Void,AnnotatedTypeMirror>

Overrides:

visitNewArray in class com.sun.source.util.SimpleTreeVisitor<java.lang.Void,AnnotatedTypeMirror>

visitCompoundAssignment

public java.lang.Void visitCompoundAssignment(com.sun.source.tree.CompoundAssignmentTree node,
                                              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>

visitBinary

public java.lang.Void visitBinary(com.sun.source.tree.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 com.sun.source.tree.TreeVisitor<java.lang.Void,AnnotatedTypeMirror>

Overrides:

visitBinary in class TreeAnnotator

visitUnary

public java.lang.Void visitUnary(com.sun.source.tree.UnaryTree node,
                                 AnnotatedTypeMirror type)

Specified by:

visitUnary in interface com.sun.source.tree.TreeVisitor<java.lang.Void,AnnotatedTypeMirror>

Overrides:

visitUnary in class com.sun.source.util.SimpleTreeVisitor<java.lang.Void,AnnotatedTypeMirror>

visitTypeCast

public java.lang.Void visitTypeCast(com.sun.source.tree.TypeCastTree node,
                                    AnnotatedTypeMirror type)

Specified by:

visitTypeCast in interface com.sun.source.tree.TreeVisitor<java.lang.Void,AnnotatedTypeMirror>

Overrides:

visitTypeCast in class com.sun.source.util.SimpleTreeVisitor<java.lang.Void,AnnotatedTypeMirror>