org.checkerframework.framework.type.treeannotator

Class ImplicitsTreeAnnotator

java.lang.Object

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

org.checkerframework.framework.type.treeannotator.TreeAnnotator

org.checkerframework.framework.type.treeannotator.ImplicitsTreeAnnotator

All Implemented Interfaces:

TreeVisitor<Void,AnnotatedTypeMirror>

public class ImplicitsTreeAnnotator
extends TreeAnnotator

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.addComputedTypeAnnotations(javax.lang.model.element.Element, org.checkerframework.framework.type.AnnotatedTypeMirror) and AnnotatedTypeFactory.addComputedTypeAnnotations(com.sun.source.tree.Tree, org.checkerframework.framework.type.AnnotatedTypeMirror).

ImplicitsTreeAnnotator does not traverse trees deeply by default.

This class takes care of three of the attributes of ImplicitFor; the others are handled in ImplicitsTypeAnnotator.

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:

ImplicitsTypeAnnotator, TreeAnnotator

Field Summary

Fields

Modifier and Type	Field and Description
protected QualifierHierarchy	qualHierarchy

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
ImplicitsTreeAnnotator(AnnotatedTypeFactory atypeFactory) Creates a ImplicitsTypeAnnotator from the given checker, using that checker to determine the annotations that are in the type hierarchy.

Method Summary

Modifier and Type	Method and Description
void	addLiteralKind(LiteralKind literalKind, AnnotationMirror theQual) Added an implicit rule for a particular LiteralKind
void	addStringPattern(String pattern, AnnotationMirror theQual) Added an implicit rule for all String literals that match the given pattern
void	addTreeClass(Class<? extends Tree> treeClass, AnnotationMirror theQual) Added an implicit rule for a particular Tree class
void	addTreeKind(Tree.Kind treeKind, AnnotationMirror theQual) Added an implicit rule for a particular Tree.Kind
Void	defaultAction(Tree tree, AnnotatedTypeMirror type)
Void	visitLiteral(LiteralTree tree, AnnotatedTypeMirror type) Go through the string patterns and add the greatest lower bound of all matching patterns.

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

visitBinary, visitMethod

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

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

Methods inherited from class java.lang.Object

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

Field Detail

qualHierarchy

protected final QualifierHierarchy qualHierarchy

Constructor Detail

ImplicitsTreeAnnotator

public ImplicitsTreeAnnotator(AnnotatedTypeFactory atypeFactory)

Creates a ImplicitsTypeAnnotator from the given checker, using that checker to determine the annotations that are in the type hierarchy.

Method Detail

addTreeClass

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

Added an implicit rule for a particular Tree class

Parameters:

treeClass - tree class that should be implicited to theQual

theQual - the AnnotationMirror that should be applied to the treeClass

addLiteralKind

public void addLiteralKind(LiteralKind literalKind,
                           AnnotationMirror theQual)

Added an implicit rule for a particular LiteralKind

Parameters:

literalKind - LiteralKind that should be implicited to theQual

theQual - the AnnotationMirror that should be applied to the literalKind

addTreeKind

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

Added an implicit rule for a particular Tree.Kind

Parameters:

treeKind - Tree.Kind that should be implicited to theQual

theQual - the AnnotationMirror that should be applied to the treeKind

addStringPattern

public void addStringPattern(String pattern,
                             AnnotationMirror theQual)

Added an implicit rule for all String literals that match the given pattern

Parameters:

pattern - pattern to match Strings against

theQual - AnnotationMirror to apply to Strings that match the pattern

defaultAction

public Void defaultAction(Tree tree,
                          AnnotatedTypeMirror type)

Overrides:

defaultAction in class SimpleTreeVisitor<Void,AnnotatedTypeMirror>

visitLiteral

public Void visitLiteral(LiteralTree tree,
                         AnnotatedTypeMirror type)

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

Specified by:

visitLiteral in interface TreeVisitor<Void,AnnotatedTypeMirror>

Overrides:

visitLiteral in class SimpleTreeVisitor<Void,AnnotatedTypeMirror>