Package org.checkerframework.checker.nullness

Class KeyForVisitor

java.lang.Object

com.sun.source.util.TreeScanner<Void,Void>

com.sun.source.util.TreePathScanner<Void,Void>

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

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

org.checkerframework.checker.nullness.KeyForVisitor

All Implemented Interfaces:

TreeVisitor<Void,Void>

public class KeyForVisitor
extends BaseTypeVisitor<KeyForAnnotatedTypeFactory>

The visitor for the Map Key Checker.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	KeyForVisitor.KeyForOverrideChecker	An override checker that does not check the lower bounds of an overriding method's type parameters.

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

BaseTypeVisitor.FoundRequired, BaseTypeVisitor.OverrideChecker

Field Summary

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

assumePureGetters, atypeFactory, checker, DETERMINISTIC, IMPURE, methodTree, positions, PURE, qualHierarchy, showchecks, SIDE_EFFECT_FREE, slowTypecheckingSeconds, slowTypecheckingTree, TARGET, targetValueElement, typeHierarchy, typeValidator, unusedWhenElement, warnRedundantAnnotations

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

elements, root, trees, treesWithSuppressWarnings, types

Constructor Summary

Constructors

Constructor	Description
KeyForVisitor(BaseTypeChecker checker)	Create a KeyForVisitor.

Method Summary

Modifier and Type	Method	Description
protected BaseTypeVisitor<KeyForAnnotatedTypeFactory>.OverrideChecker	createOverrideChecker(Tree overriderTree, AnnotatedTypeMirror.AnnotatedExecutableType overrider, AnnotatedTypeMirror overriderType, AnnotatedTypeMirror overriderReturnType, AnnotatedTypeMirror.AnnotatedExecutableType overridden, AnnotatedTypeMirror.AnnotatedDeclaredType overriddenType, AnnotatedTypeMirror overriddenReturnType)	Create an OverrideChecker.

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

checkAccess, checkAccessAllowed, checkArguments, checkArrayInitialization, checkConditionalPostcondition, checkConstructorInvocation, checkConstructorResult, checkContract, checkDefaultConstructor, checkExceptionParameter, checkExplicitAnnotationsOnIntersectionBounds, checkExtendsAndImplements, checkExtendsOrImplements, checkFieldInvariantDeclarations, checkFunctionalArgument, checkFunctionalArguments, checkLambdaPurity, checkLambdaSideEffectsOnly, checkMethodInvocability, checkMethodReferenceAsOverride, checkOverride, checkOverride, checkPostcondition, checkPreconditions, checkPurityAnnotations, checkQualifierParameter, checkSideEffectsOnlyAnnotation, checkSideEffectsOnlyExpressions, checkSuperConstructorCall, checkThisConstructorCall, checkThisOrSuperConstructorCall, checkThrownExpression, checkTypeArguments, checkTypecastRedundancy, checkTypecastSafety, checkVarargs, commonAssignmentCheck, commonAssignmentCheck, commonAssignmentCheck, commonAssignmentCheckEndDiagnostic, commonAssignmentCheckEndDiagnostic, commonAssignmentCheckStartDiagnostic, contractExpressionAndType, createTypeFactory, createTypeFactoryPublic, createTypeValidator, enclosingMemberSelect, enclosingStatement, getExceptionParameterLowerBoundAnnotations, getThrowUpperBoundAnnotations, getTypeFactory, isTypeCastSafe, isValidUse, isValidUse, isValidUse, processClassTree, processMethodTree, purityKindsToString, reportMethodInvocabilityError, reportPurityErrors, scan, setRoot, shouldPerformContractInference, shouldSkipClass, shouldSkipUses, shouldWarnAboutIrrelevantJavaTypes, sideEffectsOnlyParseError, skipReceiverSubtypeCheck, testAnnotationInsertion, testJointJavacJavaParserVisitor, testTypevarContainment, typeCheckVectorCopyIntoArgument, validateType, validateTypeOf, visitAnnotatedType, visitAnnotatedType, visitAnnotation, visitAssignment, visitCatch, visitClass, visitCompilationUnit, visitCompoundAssignment, visitConditionalExpression, visitEnhancedForLoop, visitIdentifier, visitInstanceOf, visitLambdaExpression, visitMemberReference, visitMethod, visitMethodInvocation, visitNewArray, visitNewClass, visitReturn, visitSwitchExpression, visitThrow, visitTypeCast, visitTypeParameter, visitUnary, visitVariable, warnAboutIrrelevantJavaTypes, warnInvalidPolymorphicQualifier, warnInvalidPolymorphicQualifier, warnRedundantAnnotations

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

storeSuppressWarningsAnno, visit

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

getCurrentPath, scan

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

reduce, scan, visitAnyPattern, visitArrayAccess, visitArrayType, visitAssert, visitBinary, visitBindingPattern, visitBlock, visitBreak, visitCase, visitConstantCaseLabel, visitContinue, visitDeconstructionPattern, visitDefaultCaseLabel, visitDoWhileLoop, visitEmptyStatement, visitErroneous, visitExports, visitExpressionStatement, visitForLoop, visitIf, visitImport, visitIntersectionType, visitLabeledStatement, visitLiteral, visitMemberSelect, visitModifiers, visitModule, visitOpens, visitOther, visitPackage, visitParameterizedType, visitParenthesized, visitPatternCaseLabel, visitPrimitiveType, visitProvides, visitRequires, visitStringTemplate, visitSwitch, visitSynchronized, visitTry, visitUnionType, visitUses, visitWhileLoop, visitWildcard, visitYield

Methods inherited from class java.lang.Object

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

Constructor Details

KeyForVisitor

public KeyForVisitor(BaseTypeChecker checker)

Create a KeyForVisitor.

Parameters:

checker - the associated checker

Method Details

createOverrideChecker

protected BaseTypeVisitor<KeyForAnnotatedTypeFactory>.OverrideChecker createOverrideChecker(Tree overriderTree,
 AnnotatedTypeMirror.AnnotatedExecutableType overrider,
 AnnotatedTypeMirror overriderType,
 AnnotatedTypeMirror overriderReturnType,
 AnnotatedTypeMirror.AnnotatedExecutableType overridden,
 AnnotatedTypeMirror.AnnotatedDeclaredType overriddenType,
 AnnotatedTypeMirror overriddenReturnType)

Description copied from class: BaseTypeVisitor

Create an OverrideChecker.

This exists so that subclasses can subclass OverrideChecker and use their subclass instead of using OverrideChecker itself.

Overrides:

createOverrideChecker in class BaseTypeVisitor<KeyForAnnotatedTypeFactory>

Parameters:

overriderTree - the AST node of the overriding method or method reference

overrider - the type of the overriding method

overriderType - the type enclosing the overrider method, usually an AnnotatedDeclaredType; for Method References may be something else

overriderReturnType - the return type of the overriding method

overridden - the type of the overridden method

overriddenType - the declared type enclosing the overridden method

overriddenReturnType - the return type of the overridden method

Returns:

an OverrideChecker