org.checkerframework.checker.interning

Class InterningVisitor

java.lang.Object

com.sun.source.util.TreeScanner<R,P>

com.sun.source.util.TreePathScanner<R,P>

org.checkerframework.framework.source.SourceVisitor<java.lang.Void,java.lang.Void>

org.checkerframework.common.basetype.BaseTypeVisitor<InterningAnnotatedTypeFactory>

org.checkerframework.checker.interning.InterningVisitor

All Implemented Interfaces:

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

public final class InterningVisitor
extends BaseTypeVisitor<InterningAnnotatedTypeFactory>

Typechecks source code for interning violations. A type is considered interned if its primary annotation is Interned or InternedDistinct. This visitor reports errors or warnings for violations for the following cases:

1. either argument to a "==" or "!=" comparison is not Interned (error "not.interned"). As a special case, the comparison is permitted if either arugment is InternedDistinct.
2. the receiver and argument for a call to an equals method are both Interned (optional warning "unnecessary.equals")

See Also:

BaseTypeVisitor

Nested Class Summary

Nested classes/interfaces inherited from class org.checkerframework.common.basetype.BaseTypeVisitor

BaseTypeVisitor.OverrideChecker

Field Summary

Fields inherited from class org.checkerframework.common.basetype.BaseTypeVisitor

atypeFactory, checker, contractsUtils, positions, TARGET, targetValueElement, typeValidator, visitorState

Fields inherited from class org.checkerframework.framework.source.SourceVisitor

elements, root, trees, treesWithSuppressWarnings, types

Constructor Summary

Constructors

Constructor and Description
InterningVisitor(BaseTypeChecker checker) Create an InterningVisitor.

Method Summary

Modifier and Type	Method and Description
protected void	checkConstructorResult(AnnotatedTypeMirror.AnnotatedExecutableType constructorType, javax.lang.model.element.ExecutableElement constructorElement) Issue a warning if the result type of the constructor is not top.
void	processClassTree(com.sun.source.tree.ClassTree node) Method to implement the @UsesObjectEquals functionality.
boolean	validateTypeOf(com.sun.source.tree.Tree tree) Tests whether the tree expressed by the passed type tree is a valid type, and emits an error if that is not the case (e.g.
java.lang.Void	visitBinary(com.sun.source.tree.BinaryTree node, java.lang.Void p) Checks comparison operators, == and !=, for INTERNING violations.
java.lang.Void	visitMethodInvocation(com.sun.source.tree.MethodInvocationTree node, java.lang.Void p) If lint option "dotequals" is specified, warn if the .equals method is used where reference equality is safe.

Methods inherited from class org.checkerframework.common.basetype.BaseTypeVisitor

checkAccess, checkArguments, checkArrayInitialization, checkConditionalPostcondition, checkConstructorInvocation, checkContract, checkDefaultConstructor, checkExceptionParameter, checkExtendsImplements, checkFieldInvariantDeclarations, checkForAnnotatedJdk, checkMethodInvocability, checkMethodReferenceAsOverride, checkOverride, checkOverride, checkPostcondition, checkPreconditions, checkSuperConstructorCall, checkThisConstructorCall, checkThisOrSuperConstructorCall, checkThrownExpression, checkTypeArguments, checkTypecastRedundancy, checkTypecastSafety, checkVarargs, commonAssignmentCheck, commonAssignmentCheck, commonAssignmentCheck, commonAssignmentCheckEndDiagnostic, commonAssignmentCheckStartDiagnostic, createOverrideChecker, createTypeFactory, createTypeValidator, enclosingMemberSelect, enclosingStatement, getExceptionParameterLowerBoundAnnotations, getThrowUpperBoundAnnotations, getTypeFactory, isAccessAllowed, isTypeCastSafe, isValidUse, isValidUse, isValidUse, reportPurityErrors, scan, setRoot, shouldSkipUses, skipReceiverSubtypeCheck, testTypevarContainment, typeCheckVectorCopyIntoArgument, validateType, visitAnnotation, visitArrayAccess, visitAssignment, visitCatch, visitClass, visitCompilationUnit, visitCompoundAssignment, visitConditionalExpression, visitEnhancedForLoop, visitIdentifier, visitInstanceOf, visitLambdaExpression, visitMemberReference, visitMethod, visitNewArray, visitNewClass, visitReturn, visitThrow, visitTypeCast, visitTypeParameter, visitUnary, visitVariable

Methods inherited from class org.checkerframework.framework.source.SourceVisitor

visit

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

getCurrentPath, scan

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

reduce, scan, visitAnnotatedType, visitArrayType, visitAssert, visitBlock, visitBreak, visitCase, visitContinue, visitDoWhileLoop, visitEmptyStatement, visitErroneous, visitExports, visitExpressionStatement, visitForLoop, visitIf, visitImport, visitIntersectionType, visitLabeledStatement, visitLiteral, visitMemberSelect, visitModifiers, visitModule, visitOpens, visitOther, visitPackage, visitParameterizedType, visitParenthesized, visitPrimitiveType, visitProvides, visitRequires, visitSwitch, visitSynchronized, visitTry, visitUnionType, visitUses, visitWhileLoop, visitWildcard

Methods inherited from class java.lang.Object

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

Constructor Detail

InterningVisitor

public InterningVisitor(BaseTypeChecker checker)

Create an InterningVisitor.

Method Detail

visitBinary

public java.lang.Void visitBinary(com.sun.source.tree.BinaryTree node,
                                  java.lang.Void p)

Checks comparison operators, == and !=, for INTERNING violations.

Specified by:

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

Overrides:

visitBinary in class com.sun.source.util.TreeScanner<java.lang.Void,java.lang.Void>

visitMethodInvocation

public java.lang.Void visitMethodInvocation(com.sun.source.tree.MethodInvocationTree node,
                                            java.lang.Void p)

If lint option "dotequals" is specified, warn if the .equals method is used where reference equality is safe.

Specified by:

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

Overrides:

visitMethodInvocation in class BaseTypeVisitor<InterningAnnotatedTypeFactory>

processClassTree

public void processClassTree(com.sun.source.tree.ClassTree node)

Method to implement the @UsesObjectEquals functionality. If a class is annotated with @UsesObjectEquals, it must:

• not override .equals(Object)
• be a subclass of Object or another class annotated with @UsesObjectEquals

If a class is not annotated with @UsesObjectEquals, it must:

• not have a superclass annotated with @UsesObjectEquals

Overrides:

processClassTree in class BaseTypeVisitor<InterningAnnotatedTypeFactory>

Parameters:

node - class to check

See Also:

SourceVisitor.visitClass(com.sun.source.tree.ClassTree, java.lang.Object)

checkConstructorResult

protected void checkConstructorResult(AnnotatedTypeMirror.AnnotatedExecutableType constructorType,
                                      javax.lang.model.element.ExecutableElement constructorElement)

Description copied from class: BaseTypeVisitor

Issue a warning if the result type of the constructor is not top. If it is a supertype of the class, then a type.invalid.conflicting.annos error will also be issued by BaseTypeVisitor.isValidUse(AnnotatedTypeMirror.AnnotatedDeclaredType,AnnotatedTypeMirror.AnnotatedDeclaredType,Tree).

Overrides:

checkConstructorResult in class BaseTypeVisitor<InterningAnnotatedTypeFactory>

Parameters:

constructorType - AnnotatedExecutableType for the constructor

constructorElement - element that declares the constructor

validateTypeOf

public boolean validateTypeOf(com.sun.source.tree.Tree tree)

Description copied from class: BaseTypeVisitor

Tests whether the tree expressed by the passed type tree is a valid type, and emits an error if that is not the case (e.g. '@Mutable String'). If the tree is a method or constructor, check the return type.

Overrides:

validateTypeOf in class BaseTypeVisitor<InterningAnnotatedTypeFactory>

Parameters:

tree - the AST type supplied by the user