Package org.checkerframework.checker.initialization

Class InitializationParentAnnotatedTypeFactory.CommitmentTreeAnnotator

java.lang.Object

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

org.checkerframework.framework.type.treeannotator.TreeAnnotator

org.checkerframework.framework.type.treeannotator.PropagationTreeAnnotator

org.checkerframework.checker.initialization.InitializationParentAnnotatedTypeFactory.CommitmentTreeAnnotator

All Implemented Interfaces:

TreeVisitor<Void,AnnotatedTypeMirror>

Enclosing class:

InitializationParentAnnotatedTypeFactory

protected class InitializationParentAnnotatedTypeFactory.CommitmentTreeAnnotator
extends PropagationTreeAnnotator

This tree annotator modifies the propagation tree annotator to add propagation rules for the freedom-before-commitment system.

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
CommitmentTreeAnnotator(InitializationParentAnnotatedTypeFactory initializationAnnotatedTypeFactory)	Creates a new CommitmentTreeAnnotator.

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	visitLiteral(LiteralTree tree, AnnotatedTypeMirror type)
Void	visitMemberSelect(MemberSelectTree tree, AnnotatedTypeMirror annotatedTypeMirror)
Void	visitMethod(MethodTree tree, AnnotatedTypeMirror p)	This method is not called when checking a method invocation against its declaration.
Void	visitNewArray(NewArrayTree tree, AnnotatedTypeMirror type)
Void	visitNewClass(NewClassTree tree, AnnotatedTypeMirror p)
Void	visitUnary(UnaryTree tree, AnnotatedTypeMirror type)

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

visitCompoundAssignment, visitTypeCast

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

log

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

defaultAction, visit, visit, visitAnnotatedType, visitAnnotation, visitAnyPattern, visitArrayAccess, visitArrayType, visitAssert, visitAssignment, visitBindingPattern, visitBlock, visitBreak, visitCase, visitCatch, visitClass, visitCompilationUnit, visitConditionalExpression, visitConstantCaseLabel, visitContinue, visitDeconstructionPattern, visitDefaultCaseLabel, visitDoWhileLoop, visitEmptyStatement, visitEnhancedForLoop, visitErroneous, visitExports, visitExpressionStatement, visitForLoop, visitIdentifier, visitIf, visitImport, visitInstanceOf, visitIntersectionType, visitLabeledStatement, visitLambdaExpression, visitMemberReference, visitMethodInvocation, visitModifiers, visitModule, visitOpens, visitOther, visitPackage, visitParameterizedType, visitParenthesized, visitPatternCaseLabel, visitPrimitiveType, visitProvides, visitRequires, visitReturn, visitStringTemplate, visitSwitch, visitSwitchExpression, visitSynchronized, visitThrow, visitTry, visitTypeParameter, 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

CommitmentTreeAnnotator

public CommitmentTreeAnnotator(InitializationParentAnnotatedTypeFactory initializationAnnotatedTypeFactory)

Creates a new CommitmentTreeAnnotator.

Parameters:

initializationAnnotatedTypeFactory - this factory

Method Details

visitMethod

public Void visitMethod(MethodTree tree,
 AnnotatedTypeMirror p)

Description copied from class: TreeAnnotator

This method is not called when checking a method invocation against its declaration. So, instead of overriding this method, override TypeAnnotator.visitExecutable. TypeAnnotator.visitExecutable is called both when checking method declarations and method invocations.

Specified by:

visitMethod in interface TreeVisitor<Void,AnnotatedTypeMirror>

Overrides:

visitMethod in class TreeAnnotator

See Also:

• TypeAnnotator

visitNewClass

public Void visitNewClass(NewClassTree tree,
 AnnotatedTypeMirror p)

Specified by:

visitNewClass in interface TreeVisitor<Void,AnnotatedTypeMirror>

Overrides:

visitNewClass in class SimpleTreeVisitor<Void,AnnotatedTypeMirror>

visitLiteral

public Void visitLiteral(LiteralTree tree,
 AnnotatedTypeMirror type)

Specified by:

visitLiteral in interface TreeVisitor<Void,AnnotatedTypeMirror>

Overrides:

visitLiteral 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 PropagationTreeAnnotator

visitMemberSelect

public Void visitMemberSelect(MemberSelectTree tree,
 AnnotatedTypeMirror annotatedTypeMirror)

Specified by:

visitMemberSelect in interface TreeVisitor<Void,AnnotatedTypeMirror>

Overrides:

visitMemberSelect in class SimpleTreeVisitor<Void,AnnotatedTypeMirror>

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.hasAnnotationInHierarchy(...) 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 PropagationTreeAnnotator

visitUnary

public Void visitUnary(UnaryTree tree,
 AnnotatedTypeMirror type)

Specified by:

visitUnary in interface TreeVisitor<Void,AnnotatedTypeMirror>

Overrides:

visitUnary in class PropagationTreeAnnotator