org.checkerframework.checker.lock

Class LockAnnotatedTypeFactory

java.lang.Object

org.checkerframework.framework.type.AnnotatedTypeFactory

org.checkerframework.framework.type.GenericAnnotatedTypeFactory<org.checkerframework.framework.flow.CFValue,LockStore,LockTransfer,LockAnalysis>

org.checkerframework.checker.lock.LockAnnotatedTypeFactory

All Implemented Interfaces:

org.checkerframework.javacutil.AnnotationProvider

public class LockAnnotatedTypeFactory
extends org.checkerframework.framework.type.GenericAnnotatedTypeFactory<org.checkerframework.framework.flow.CFValue,LockStore,LockTransfer,LockAnalysis>

LockAnnotatedTypeFactory builds types with @LockHeld and @LockPossiblyHeld annotations. LockHeld identifies that an object is being used as a lock and is being held when a given tree is executed. LockPossiblyHeld is the default type qualifier for this hierarchy and applies to all fields, local variables and parameters -- hence it does not convey any information other than that it is not LockHeld.

However, there are a number of other annotations used in conjunction with these annotations to enforce proper locking.

See the Checker Framework Manual:

Lock Checker

Nested Class Summary

Nested classes/interfaces inherited from class org.checkerframework.framework.type.GenericAnnotatedTypeFactory

org.checkerframework.framework.type.GenericAnnotatedTypeFactory.ScanState

Nested classes/interfaces inherited from class org.checkerframework.framework.type.AnnotatedTypeFactory

org.checkerframework.framework.type.AnnotatedTypeFactory.InheritedFromClassAnnotator

Field Summary

Fields

Modifier and Type	Field and Description
protected AnnotationMirror	GUARDEDBY Annotation constants
protected AnnotationMirror	GUARDEDBYBOTTOM Annotation constants
protected AnnotationMirror	GUARDEDBYUNKNOWN Annotation constants
protected AnnotationMirror	GUARDSATISFIED Annotation constants
protected Class<? extends Annotation>	javax_GuardedBy
protected Class<? extends Annotation>	jcip_GuardedBy
protected AnnotationMirror	LOCKHELD Annotation constants
protected AnnotationMirror	LOCKPOSSIBLYHELD Annotation constants
static String	NOT_EFFECTIVELY_FINAL dependent type annotation error message for when the expression is not effectively final.
protected AnnotationMirror	SIDEEFFECTFREE Annotation constants

Fields inherited from class org.checkerframework.framework.type.GenericAnnotatedTypeFactory

analysis, cfgVisualizer, defaults, dependentTypesHelper, emptyStore, FLOW_BY_DEFAULT, flowResult, flowResultAnalysisCaches, initializationStaticStore, initializationStore, methodInvocationStores, poly, regularExitStores, returnStatementStores, scannedClasses, transfer, treeAnnotator, typeAnnotator

Fields inherited from class org.checkerframework.framework.type.AnnotatedTypeFactory

checker, elements, fromExpressionTreeCache, fromMemberTreeCache, fromTypeTreeCache, ignoreUninferredTypeArguments, loader, processingEnv, qualHierarchy, reflectionResolver, root, shouldCache, trees, typeArgumentInference, typeFormatter, typeHierarchy, types, typeVarSubstitutor, uid, visitorState

Constructor Summary

Constructors

Constructor and Description
LockAnnotatedTypeFactory(org.checkerframework.common.basetype.BaseTypeChecker checker)

Method Summary

Modifier and Type	Method and Description
void	addComputedTypeAnnotations(Element elt, org.checkerframework.framework.type.AnnotatedTypeMirror type)
void	addComputedTypeAnnotations(Tree tree, org.checkerframework.framework.type.AnnotatedTypeMirror type, boolean useFlow)
protected org.checkerframework.framework.util.dependenttypes.DependentTypesHelper	createDependentTypesHelper()
protected LockAnalysis	createFlowAnalysis(List<org.checkerframework.javacutil.Pair<VariableElement,org.checkerframework.framework.flow.CFValue>> fieldValues)
LockTransfer	createFlowTransferFunction(org.checkerframework.framework.flow.CFAbstractAnalysis<org.checkerframework.framework.flow.CFValue,LockStore,LockTransfer> analysis)
org.checkerframework.framework.type.QualifierHierarchy	createQualifierHierarchy(org.checkerframework.framework.util.MultiGraphQualifierHierarchy.MultiGraphFactory factory)
protected Set<Class<? extends Annotation>>	createSupportedTypeQualifiers()
protected org.checkerframework.framework.type.treeannotator.TreeAnnotator	createTreeAnnotator()
org.checkerframework.javacutil.Pair<org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedExecutableType,List<org.checkerframework.framework.type.AnnotatedTypeMirror>>	methodFromUse(ExpressionTree tree, ExecutableElement methodElt, org.checkerframework.framework.type.AnnotatedTypeMirror receiverType)

Methods inherited from class org.checkerframework.framework.type.GenericAnnotatedTypeFactory

addCheckedCodeDefaults, addCheckedStandardDefaults, addComputedTypeAnnotations, addDefaultAnnotations, addTypeNameImplicit, addUncheckedCodeDefaults, addUncheckedStandardDefaults, analyze, applyInferredAnnotations, checkAndPerformFlowAnalysis, checkForDefaultQualifierInHierarchy, constructorFromUse, createAndInitQualifierDefaults, createCFGVisualizer, createQualifierDefaults, createQualifierPolymorphism, createTypeAnnotator, fromNewClass, getAnnotatedTypeLhs, getAnnotatedTypeLhsNoTypeVarDefault, getAnnotatedTypeRhsUnaryAssign, getAnnotatedTypeVarargsArray, getAnnotationFromJavaExpressionString, getAnnotationFromReceiver, getAnnotationMirrorFromJavaExpressionString, getCFGVisualizer, getDependentTypesHelper, getEmptyStore, getFinalLocalValues, getFirstNodeOfKindForTree, getInferredValueFor, getMethodReturnType, getMethodReturnType, getNodesForTree, getReceiverFromJavaExpressionString, getRegularExitStore, getResultingTypeOfConstructorMemberReference, getReturnStatementStores, getShouldDefaultTypeVarLocals, getSortedQualifierNames, getStoreAfter, getStoreAfter, getStoreAfter, getStoreBefore, getStoreBefore, getStoreBefore, getSupportedMonotonicTypeQualifiers, getTypeFactoryOfSubchecker, handleCFGViz, methodFromUse, performFlowAnalysis, postDirectSuperTypes, postInit, preProcessClassTree, setRoot, typeVariablesFromUse

Methods inherited from class org.checkerframework.framework.type.AnnotatedTypeFactory

adaptGetClassReturnTypeToReceiver, addAliasedAnnotation, addAliasedAnnotation, addAliasedAnnotation, addAliasedAnnotation, addAliasedDeclAnnotation, addAnnotationFromFieldInvariant, addInheritedAnnotation, aliasedAnnotation, annotateInheritedFromClass, annotateInheritedFromClass, checkInvalidOptionsInferSignatures, createAnnotatedTypeFormatter, createAnnotationClassLoader, createAnnotationFormatter, createQualifierHierarchy, createQualifierHierarchy, createQualifierHierarchyFactory, createTypeArgumentInference, createTypeHierarchy, createTypeVariableSubstitutor, declarationFromElement, fromElement, fromElement, fromElement, getAnnotatedNullType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedTypeFormatter, getAnnotatedTypeFromTypeTree, getAnnotationFormatter, getAnnotationMirror, getAnnotationWithMetaAnnotation, getBoxedType, getBundledTypeQualifiersWithoutPolyAll, getBundledTypeQualifiersWithPolyAll, getCacheSize, getContext, getCurrentClassTree, getCurrentClassType, getCurrentMethodReceiver, getDeclAnnotation, getDeclAnnotationNoAliases, getDeclAnnotations, getDeclAnnotationWithMetaAnnotation, getElementUtils, getEnclosingMethod, getEnclosingType, getFieldInvariantAnnotationTree, getFieldInvariantDeclarationAnnotations, getFieldInvariants, getFnInterfaceFromTree, getFnInterfaceFromTree, getImplicitReceiverType, getNarrowedPrimitive, getPath, getProcessingEnv, getQualifierHierarchy, getReceiverType, getSelfType, getStringType, getSupportedTypeQualifiers, getTreeUtils, getTypeArgumentInference, getTypeHierarchy, getTypeVarSubstitutor, getUnboxedType, getUninferredWildcardType, getVisitorState, getWholeProgramInference, initializeReflectionResolution, isAnyEnclosingThisDeref, isFromByteCode, isFromStubFile, isMostEnclosingThisDeref, isSupportedQualifier, isWithinConstructor, parseStubFiles, postAsMemberOf, postProcessClassTree, postTypeVarSubstitution, setPathHack, toAnnotatedType, toString, type, widenToUpperBound

Methods inherited from class java.lang.Object

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

Field Detail

NOT_EFFECTIVELY_FINAL

public static final String NOT_EFFECTIVELY_FINAL

dependent type annotation error message for when the expression is not effectively final.

See Also:

Constant Field Values

LOCKHELD

protected final AnnotationMirror LOCKHELD

Annotation constants

LOCKPOSSIBLYHELD

protected final AnnotationMirror LOCKPOSSIBLYHELD

Annotation constants

SIDEEFFECTFREE

protected final AnnotationMirror SIDEEFFECTFREE

Annotation constants

GUARDEDBYUNKNOWN

protected final AnnotationMirror GUARDEDBYUNKNOWN

Annotation constants

GUARDEDBY

protected final AnnotationMirror GUARDEDBY

Annotation constants

GUARDEDBYBOTTOM

protected final AnnotationMirror GUARDEDBYBOTTOM

Annotation constants

GUARDSATISFIED

protected final AnnotationMirror GUARDSATISFIED

Annotation constants

jcip_GuardedBy

protected final Class<? extends Annotation> jcip_GuardedBy

javax_GuardedBy

protected final Class<? extends Annotation> javax_GuardedBy

Constructor Detail

LockAnnotatedTypeFactory

public LockAnnotatedTypeFactory(org.checkerframework.common.basetype.BaseTypeChecker checker)

Method Detail

createDependentTypesHelper

protected org.checkerframework.framework.util.dependenttypes.DependentTypesHelper createDependentTypesHelper()

Overrides:

createDependentTypesHelper in class org.checkerframework.framework.type.GenericAnnotatedTypeFactory<org.checkerframework.framework.flow.CFValue,LockStore,LockTransfer,LockAnalysis>

createSupportedTypeQualifiers

protected Set<Class<? extends Annotation>> createSupportedTypeQualifiers()

Overrides:

createSupportedTypeQualifiers in class org.checkerframework.framework.type.AnnotatedTypeFactory

createQualifierHierarchy

public org.checkerframework.framework.type.QualifierHierarchy createQualifierHierarchy(org.checkerframework.framework.util.MultiGraphQualifierHierarchy.MultiGraphFactory factory)

Overrides:

createQualifierHierarchy in class org.checkerframework.framework.type.AnnotatedTypeFactory

createFlowAnalysis

protected LockAnalysis createFlowAnalysis(List<org.checkerframework.javacutil.Pair<VariableElement,org.checkerframework.framework.flow.CFValue>> fieldValues)

Overrides:

createFlowAnalysis in class org.checkerframework.framework.type.GenericAnnotatedTypeFactory<org.checkerframework.framework.flow.CFValue,LockStore,LockTransfer,LockAnalysis>

createFlowTransferFunction

public LockTransfer createFlowTransferFunction(org.checkerframework.framework.flow.CFAbstractAnalysis<org.checkerframework.framework.flow.CFValue,LockStore,LockTransfer> analysis)

Overrides:

createFlowTransferFunction in class org.checkerframework.framework.type.GenericAnnotatedTypeFactory<org.checkerframework.framework.flow.CFValue,LockStore,LockTransfer,LockAnalysis>

methodFromUse

public org.checkerframework.javacutil.Pair<org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedExecutableType,List<org.checkerframework.framework.type.AnnotatedTypeMirror>> methodFromUse(ExpressionTree tree,
                                                                                                                                                                                                        ExecutableElement methodElt,
                                                                                                                                                                                                        org.checkerframework.framework.type.AnnotatedTypeMirror receiverType)

Overrides:

methodFromUse in class org.checkerframework.framework.type.AnnotatedTypeFactory

createTreeAnnotator

protected org.checkerframework.framework.type.treeannotator.TreeAnnotator createTreeAnnotator()

Overrides:

createTreeAnnotator in class org.checkerframework.framework.type.GenericAnnotatedTypeFactory<org.checkerframework.framework.flow.CFValue,LockStore,LockTransfer,LockAnalysis>

addComputedTypeAnnotations

public void addComputedTypeAnnotations(Element elt,
                                       org.checkerframework.framework.type.AnnotatedTypeMirror type)

Overrides:

addComputedTypeAnnotations in class org.checkerframework.framework.type.GenericAnnotatedTypeFactory<org.checkerframework.framework.flow.CFValue,LockStore,LockTransfer,LockAnalysis>

addComputedTypeAnnotations

public void addComputedTypeAnnotations(Tree tree,
                                       org.checkerframework.framework.type.AnnotatedTypeMirror type,
                                       boolean useFlow)

Overrides:

addComputedTypeAnnotations in class org.checkerframework.framework.type.GenericAnnotatedTypeFactory<org.checkerframework.framework.flow.CFValue,LockStore,LockTransfer,LockAnalysis>