Class ElementQualifierHierarchy
- All Implemented Interfaces:
QualifierHierarchy
- Direct Known Subclasses:
AccumulationAnnotatedTypeFactory.AccumulationQualifierHierarchy
,ClassValAnnotatedTypeFactory.ClassValQualifierHierarchy
,MethodValAnnotatedTypeFactory.MethodValQualifierHierarchy
,MostlyNoElementQualifierHierarchy
,UpperBoundAnnotatedTypeFactory.UpperBoundQualifierHierarchy
QualifierHierarchy
where qualifiers may be represented by annotations with elements.
ElementQualifierHierarchy uses a QualifierKindHierarchy
to model the relationships
between qualifiers. (By contrast, MostlyNoElementQualifierHierarchy
uses the QualifierKindHierarchy
to implement isSubtype
, leastUpperBound
, and
greatestLowerBound
methods for qualifiers without elements.)
Subclasses can override createQualifierKindHierarchy(Collection)
to return a subclass
of QualifierKindHierarchy.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final Set<AnnotationMirror>
The set of bottom annotation mirrors.protected final Map<QualifierKind,
AnnotationMirror> A mapping from bottom QualifierKinds to their corresponding AnnotationMirror.protected final Map<QualifierKind,
AnnotationMirror> A mapping from QualifierKind to AnnotationMirror for all qualifiers whose annotations do not have elements.protected final QualifierKindHierarchy
protected final Set<AnnotationMirror>
The set of top annotation mirrors.protected final Map<QualifierKind,
AnnotationMirror> A mapping from top QualifierKinds to their corresponding AnnotationMirror. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
ElementQualifierHierarchy
(Collection<Class<? extends Annotation>> qualifierClasses, Elements elements) Creates a ElementQualifierHierarchy from the given classes. -
Method Summary
Modifier and TypeMethodDescriptionprotected Map<QualifierKind,
AnnotationMirror> Creates a mapping from QualifierKind to AnnotationMirror, where the QualifierKind is bottom and the AnnotationMirror is bottom in their respective hierarchies.protected Map<QualifierKind,
AnnotationMirror> Creates a mapping from QualifierKind to AnnotationMirror for all qualifiers whose annotations do not have elements.protected QualifierKindHierarchy
createQualifierKindHierarchy
(Collection<Class<? extends Annotation>> qualifierClasses) Create theQualifierKindHierarchy
.protected Map<QualifierKind,
AnnotationMirror> Creates a mapping from QualifierKind to AnnotationMirror, where the QualifierKind is top and the AnnotationMirror is top in their respective hierarchies.findAnnotationInHierarchy
(Collection<? extends AnnotationMirror> annos, AnnotationMirror top) Returns the annotation inqualifiers
that is in the hierarchy for whichtop
is top.findAnnotationInSameHierarchy
(Collection<? extends AnnotationMirror> annos, AnnotationMirror annotationMirror) Returns the annotation inqualifiers
that is in the same hierarchy asqualifier
.Return the bottom for the given qualifier, that is, the qualifier that is a subtype ofqualifier
but no further subtypes exist.Set<? extends AnnotationMirror>
Returns the bottom type qualifiers in the hierarchy.Returns the polymorphic qualifier for the hierarchy containingqualifier
, ornull
if there is no polymorphic qualifier in that hierarchy.protected QualifierKind
Returns the qualifier kind for the annotation with the canonical namename
.protected QualifierKind
Returns the qualifier kind for the given annotation.getTopAnnotation
(AnnotationMirror start) Return the top qualifier for the given qualifier, that is, the qualifier that is a supertype ofqualifier
but no further supertypes exist.Set<? extends AnnotationMirror>
Returns the top (ultimate super) type qualifiers in the type system.boolean
isPolymorphicQualifier
(AnnotationMirror qualifier) Returnstrue
if the qualifier is a polymorphic qualifier; otherwise, returnsfalse
.boolean
isValid()
Determine whether this is valid.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.checkerframework.framework.type.QualifierHierarchy
getWidth, greatestLowerBound, greatestLowerBounds, isSubtype, isSubtype, leastUpperBound, leastUpperBounds, numberOfIterationsBeforeWidening, updateMappingToMutableSet, widenedUpperBound
-
Field Details
-
qualifierKindHierarchy
-
topsMap
A mapping from top QualifierKinds to their corresponding AnnotationMirror. -
tops
The set of top annotation mirrors. -
bottomsMap
A mapping from bottom QualifierKinds to their corresponding AnnotationMirror. -
bottoms
The set of bottom annotation mirrors. -
kindToElementlessQualifier
A mapping from QualifierKind to AnnotationMirror for all qualifiers whose annotations do not have elements.
-
-
Constructor Details
-
ElementQualifierHierarchy
protected ElementQualifierHierarchy(Collection<Class<? extends Annotation>> qualifierClasses, Elements elements) Creates a ElementQualifierHierarchy from the given classes.- Parameters:
qualifierClasses
- classes of annotations that are the qualifiers for this hierarchyelements
- element utils
-
-
Method Details
-
isValid
public boolean isValid()Description copied from interface:QualifierHierarchy
Determine whether this is valid.- Specified by:
isValid
in interfaceQualifierHierarchy
- Returns:
- whether this is valid
-
createQualifierKindHierarchy
protected QualifierKindHierarchy createQualifierKindHierarchy(@UnderInitialization ElementQualifierHierarchy this, Collection<Class<? extends Annotation>> qualifierClasses) Create theQualifierKindHierarchy
. (Subclasses may override to return a subclass of QualifierKindHierarchy.)- Parameters:
qualifierClasses
- classes of annotations that are the qualifiers for this hierarchy- Returns:
- the newly created qualifier kind hierarchy
-
createElementlessQualifierMap
@RequiresNonNull({"this.qualifierKindHierarchy","this.elements"}) protected Map<QualifierKind,AnnotationMirror> createElementlessQualifierMap(@UnderInitialization ElementQualifierHierarchy this) Creates a mapping from QualifierKind to AnnotationMirror for all qualifiers whose annotations do not have elements.- Returns:
- the mapping
-
createTopsMap
@RequiresNonNull({"this.qualifierKindHierarchy","this.elements"}) protected Map<QualifierKind,AnnotationMirror> createTopsMap(@UnderInitialization ElementQualifierHierarchy this) Creates a mapping from QualifierKind to AnnotationMirror, where the QualifierKind is top and the AnnotationMirror is top in their respective hierarchies.This implementation works if the top annotation has no elements, or if it has elements, provides a default, and that default is the top. Otherwise, subclasses must override this.
- Returns:
- a mapping from top QualifierKind to top AnnotationMirror
-
createBottomsMap
@RequiresNonNull({"this.qualifierKindHierarchy","this.elements"}) protected Map<QualifierKind,AnnotationMirror> createBottomsMap(@UnderInitialization ElementQualifierHierarchy this) Creates a mapping from QualifierKind to AnnotationMirror, where the QualifierKind is bottom and the AnnotationMirror is bottom in their respective hierarchies.This implementation works if the bottom annotation has no elements, or if it has elements, provides a default, and that default is the bottom. Otherwise, subclasses must override this.
- Returns:
- a mapping from bottom QualifierKind to bottom AnnotationMirror
-
getQualifierKind
Returns the qualifier kind for the given annotation.- Parameters:
anno
- an annotation mirror that is in this hierarchy- Returns:
- the qualifier kind for the given annotation
-
getQualifierKind
Returns the qualifier kind for the annotation with the canonical namename
.- Parameters:
name
- fully qualified annotation name- Returns:
- the qualifier kind for the annotation named
name
-
getTopAnnotations
Description copied from interface:QualifierHierarchy
Returns the top (ultimate super) type qualifiers in the type system. The size of this set is equal toQualifierHierarchy.getWidth()
.- Specified by:
getTopAnnotations
in interfaceQualifierHierarchy
- Returns:
- the top (ultimate super) type qualifiers in the type system
-
getTopAnnotation
Description copied from interface:QualifierHierarchy
Return the top qualifier for the given qualifier, that is, the qualifier that is a supertype ofqualifier
but no further supertypes exist.- Specified by:
getTopAnnotation
in interfaceQualifierHierarchy
- Parameters:
start
- any qualifier from one of the qualifier hierarchies represented by this- Returns:
- the top qualifier of
qualifier
's hierarchy
-
getBottomAnnotations
Description copied from interface:QualifierHierarchy
Returns the bottom type qualifiers in the hierarchy. The size of this set is equal toQualifierHierarchy.getWidth()
.- Specified by:
getBottomAnnotations
in interfaceQualifierHierarchy
- Returns:
- the bottom type qualifiers in the hierarchy
-
getPolymorphicAnnotation
Description copied from interface:QualifierHierarchy
Returns the polymorphic qualifier for the hierarchy containingqualifier
, ornull
if there is no polymorphic qualifier in that hierarchy.- Specified by:
getPolymorphicAnnotation
in interfaceQualifierHierarchy
- Parameters:
start
- any qualifier from one of the qualifier hierarchies represented by this- Returns:
- the polymorphic qualifier for the hierarchy containing
qualifier
, ornull
if there is no polymorphic qualifier in that hierarchy
-
isPolymorphicQualifier
Description copied from interface:QualifierHierarchy
Returnstrue
if the qualifier is a polymorphic qualifier; otherwise, returnsfalse
.- Specified by:
isPolymorphicQualifier
in interfaceQualifierHierarchy
- Parameters:
qualifier
- qualifier- Returns:
true
if the qualifier is a polymorphic qualifier; otherwise, returnsfalse
.
-
getBottomAnnotation
Description copied from interface:QualifierHierarchy
Return the bottom for the given qualifier, that is, the qualifier that is a subtype ofqualifier
but no further subtypes exist.- Specified by:
getBottomAnnotation
in interfaceQualifierHierarchy
- Parameters:
start
- any qualifier from one of the qualifier hierarchies represented by this- Returns:
- the bottom qualifier of
qualifier
's hierarchy
-
findAnnotationInSameHierarchy
public @Nullable AnnotationMirror findAnnotationInSameHierarchy(Collection<? extends AnnotationMirror> annos, AnnotationMirror annotationMirror) Description copied from interface:QualifierHierarchy
Returns the annotation inqualifiers
that is in the same hierarchy asqualifier
.The default implementation calls
QualifierHierarchy.getTopAnnotation(AnnotationMirror)
and then callsQualifierHierarchy.findAnnotationInHierarchy(Collection, AnnotationMirror)
. So, ifqualifier
is a top qualifier, then callQualifierHierarchy.findAnnotationInHierarchy(Collection, AnnotationMirror)
directly is faster.- Specified by:
findAnnotationInSameHierarchy
in interfaceQualifierHierarchy
- Parameters:
annos
- set of annotations to searchannotationMirror
- annotation that is in the same hierarchy as the returned annotation- Returns:
- annotation in the same hierarchy as qualifier, or null if one is not found
-
findAnnotationInHierarchy
public @Nullable AnnotationMirror findAnnotationInHierarchy(Collection<? extends AnnotationMirror> annos, AnnotationMirror top) Description copied from interface:QualifierHierarchy
Returns the annotation inqualifiers
that is in the hierarchy for whichtop
is top.- Specified by:
findAnnotationInHierarchy
in interfaceQualifierHierarchy
- Parameters:
annos
- set of annotations to searchtop
- the top annotation in the hierarchy to which the returned annotation belongs- Returns:
- annotation in the same hierarchy as annotationMirror, or null if one is not found
-