checkers.lock

Class LockAnnotatedTypeFactory

@NonNull java.lang.Object

checkers.types.AnnotatedTypeFactory

checkers.types.BasicAnnotatedTypeFactory<LockChecker>

checkers.lock.LockAnnotatedTypeFactory

public class LockAnnotatedTypeFactory
extends BasicAnnotatedTypeFactory<LockChecker>

The type factory for Lock type system. The annotated types returned by class contain GuardedBy type qualifiers only for the locks that are not currently held.

Nested Class Summary

Nested classes/interfaces inherited from class checkers.types.AnnotatedTypeFactory

AnnotatedTypeFactory.InheritedFromClassAnnotator

Field Summary

Fields inherited from class checkers.types.BasicAnnotatedTypeFactory

checker, defaults, flow, FLOW_BY_DEFAULT, poly, treeAnnotator, typeAnnotator, useFlow

Fields inherited from class checkers.types.AnnotatedTypeFactory

annotations, atypes, elements, env, fromTreeCache, qualHierarchy, root, trees, types, uid, visitorState

Constructor Summary

Constructors

Constructor and Description
LockAnnotatedTypeFactory(LockChecker checker, @Nullable CompilationUnitTree root)

Method Summary

Methods

Modifier and Type	Method and Description
@Nullable AnnotationMirror	aliasedAnnotation(@Nullable AnnotationMirror a) Returns the canonical annotation for the passed annotation if it is an alias of a canonical one in the framework.
protected void	annotateImplicit(@Nullable Tree tree, @Mutable AnnotatedTypeMirror type) Adds implicit annotations to a type obtained from a Tree.
List<@ReadOnly String>	getHeldLock()
void	setHeldLocks(List<@ReadOnly String> heldLocks)

Methods inherited from class checkers.types.BasicAnnotatedTypeFactory

annotateImplicit, annotateImplicit, constructorFromUse, createFlow, createFlowQualifiers, createTreeAnnotator, createTypeAnnotator, getDefaultedAnnotatedType, methodFromUse, postDirectSuperTypes, postInit

Methods inherited from class checkers.types.AnnotatedTypeFactory

addAliasedAnnotation, annotateInheritedFromClass, canHaveAnnotatedTypeParameters, createLRUCache, declarationFromElement, fromClass, fromElement, fromElement, fromElement, fromExpression, fromMember, fromNewClass, fromTypeTree, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedTypeFromTypeTree, getBoxedType, getCurrentClassTree, getCurrentClassType, getCurrentMethodReceiver, getDeclAnnotation, getEnclosingType, getImplicitReceiverType, getPath, getQualifierHierarchy, getReceiverType, getSelfType, getUnboxedType, getVisitorState, isAnyEnclosingThisDeref, isMostEnclosingThisDeref, isSupportedQualifier, isWithinConstructor, postAsMemberOf, toAnnotatedType, toString, typeVariablesFromUse, unify

Methods inherited from class java.lang.Object

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

Constructor Detail

LockAnnotatedTypeFactory

public LockAnnotatedTypeFactory(LockChecker checker,
                        @Nullable CompilationUnitTree root)

Method Detail

setHeldLocks

public void setHeldLocks(List<@ReadOnly String> heldLocks)

getHeldLock

public List<@ReadOnly String> getHeldLock()

annotateImplicit

protected void annotateImplicit(@Nullable Tree tree,
                    @Mutable AnnotatedTypeMirror type)

Description copied from class: AnnotatedTypeFactory

Adds implicit annotations to a type obtained from a Tree. By default, this method does nothing. Subclasses should use this method to implement implicit annotations specific to their type systems.

Overrides:

annotateImplicit in class BasicAnnotatedTypeFactory<LockChecker>

Parameters:

tree - an AST node

type - the type obtained from tree

aliasedAnnotation

public @Nullable AnnotationMirror aliasedAnnotation(@Nullable AnnotationMirror a)

Description copied from class: AnnotatedTypeFactory

Returns the canonical annotation for the passed annotation if it is an alias of a canonical one in the framework. If it is not an alias, the method returns null. Returns an aliased type of the current one

Overrides:

aliasedAnnotation in class AnnotatedTypeFactory