Package org.checkerframework.framework.type

Class MostlyNoElementQualifierHierarchy

java.lang.Object

org.checkerframework.framework.type.QualifierHierarchy

org.checkerframework.framework.type.ElementQualifierHierarchy

org.checkerframework.framework.type.MostlyNoElementQualifierHierarchy

Direct Known Subclasses:

FenumAnnotatedTypeFactory.FenumQualifierHierarchy, InitializationAnnotatedTypeFactory.InitializationQualifierHierarchy, SubtypeIsSubsetQualifierHierarchy, SubtypeIsSupersetQualifierHierarchy, UnitsAnnotatedTypeFactory.UnitsQualifierHierarchy

@AnnotatedFor("nullness")
public abstract class MostlyNoElementQualifierHierarchy
extends ElementQualifierHierarchy

A QualifierHierarchy where qualifiers may be represented by annotations with elements, but most of the qualifiers do not have elements. In contrast to ElementQualifierHierarchy, this class partially implements QualifierHierarchy.isSubtypeShallow(AnnotationMirror, TypeMirror, AnnotationMirror, TypeMirror), QualifierHierarchy.leastUpperBoundShallow(AnnotationMirror, TypeMirror, AnnotationMirror, TypeMirror), and QualifierHierarchy.greatestLowerBoundShallow(AnnotationMirror, TypeMirror, AnnotationMirror, TypeMirror) and calls *WithElements when the result cannot be computed from the meta-annotations SubtypeOf.

Subclasses must implement the following methods when annotations have elements:

• isSubtypeWithElements(AnnotationMirror, QualifierKind, AnnotationMirror, QualifierKind)
• leastUpperBoundWithElements(AnnotationMirror, QualifierKind, AnnotationMirror, QualifierKind,QualifierKind)
• greatestLowerBoundWithElements(AnnotationMirror, QualifierKind, AnnotationMirror, QualifierKind,QualifierKind)

MostlyNoElementQualifierHierarchy uses a QualifierKindHierarchy to model the relationships between qualifiers. Subclasses can override ElementQualifierHierarchy.createQualifierKindHierarchy(Collection) to return a subclass of QualifierKindHierarchy.

Field Summary

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

bottoms, bottomsMap, kindToElementlessQualifier, qualifierKindHierarchy, tops, topsMap

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

atypeFactory

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MostlyNoElementQualifierHierarchy(Collection<Class<? extends Annotation>> qualifierClasses, Elements elements, GenericAnnotatedTypeFactory<?,?,?,?> atypeFactory)	Creates a MostlyNoElementQualifierHierarchy from the given classes.

Method Summary

Modifier and Type	Method	Description
final @Nullable AnnotationMirror	greatestLowerBoundQualifiers(AnnotationMirror a1, AnnotationMirror a2)	Returns the greatest lower bound for the qualifiers qualifier1 and qualifier2.
protected abstract AnnotationMirror	greatestLowerBoundWithElements(AnnotationMirror a1, QualifierKind qualifierKind1, AnnotationMirror a2, QualifierKind qualifierKind2, QualifierKind glbKind)	Returns the greatest lower bound of a1 and a2 in cases where the glb of qualifierKind1 and qualifierKind2 is a qualifier kind that has elements.
final boolean	isSubtypeQualifiers(AnnotationMirror subAnno, AnnotationMirror superAnno)	Tests whether subQualifier is equal to or a sub-qualifier of superQualifier, according to the type qualifier hierarchy, ignoring Java basetypes.
protected abstract boolean	isSubtypeWithElements(AnnotationMirror subAnno, QualifierKind subKind, AnnotationMirror superAnno, QualifierKind superKind)	Returns true if subAnno is a subtype of superAnno.
final @Nullable AnnotationMirror	leastUpperBoundQualifiers(AnnotationMirror a1, AnnotationMirror a2)	Returns the least upper bound (LUB) of the qualifiers qualifier1 and qualifier2.
protected abstract AnnotationMirror	leastUpperBoundWithElements(AnnotationMirror a1, QualifierKind qualifierKind1, AnnotationMirror a2, QualifierKind qualifierKind2, QualifierKind lubKind)	Returns the least upper bound of a1 and a2 in cases where the lub of qualifierKind1 and qualifierKind2 is a qualifier kind that has elements.

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

createBottomsMap, createElementlessQualifierMap, createQualifierKindHierarchy, createTopsMap, findAnnotationInHierarchy, findAnnotationInSameHierarchy, getBottomAnnotation, getBottomAnnotations, getPolymorphicAnnotation, getQualifierKind, getQualifierKind, getTopAnnotation, getTopAnnotations, isPolymorphicQualifier, isValid

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

assertSameSize, assertSameSize, canHaveEmptyAnnotationSet, getWidth, greatestLowerBoundQualifiersOnly, greatestLowerBoundShallow, greatestLowerBoundsQualifiersOnly, greatestLowerBoundsQualifiersOnly, greatestLowerBoundsShallow, isSubtypeQualifiersOnly, isSubtypeQualifiersOnly, isSubtypeShallow, isSubtypeShallow, isSubtypeShallow, isSubtypeShallow, isTop, leastUpperBoundQualifiersOnly, leastUpperBoundShallow, leastUpperBoundsQualifiersOnly, leastUpperBoundsQualifiersOnly, leastUpperBoundsShallow, numberOfIterationsBeforeWidening, updateMappingToMutableSet, widenedUpperBound

Methods inherited from class java.lang.Object

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

Constructor Details

MostlyNoElementQualifierHierarchy

protected MostlyNoElementQualifierHierarchy(Collection<Class<? extends Annotation>> qualifierClasses,
 Elements elements,
 GenericAnnotatedTypeFactory<?,?,?,?> atypeFactory)

Creates a MostlyNoElementQualifierHierarchy from the given classes.

Parameters:

qualifierClasses - classes of annotations that are the qualifiers for this hierarchy

elements - element utils

atypeFactory - the associated type factory

Method Details

isSubtypeQualifiers

public final boolean isSubtypeQualifiers(AnnotationMirror subAnno,
 AnnotationMirror superAnno)

Description copied from class: QualifierHierarchy

Tests whether subQualifier is equal to or a sub-qualifier of superQualifier, according to the type qualifier hierarchy, ignoring Java basetypes.

Clients should generally call QualifierHierarchy.isSubtypeShallow(javax.lang.model.element.AnnotationMirror, javax.lang.model.type.TypeMirror, javax.lang.model.element.AnnotationMirror, javax.lang.model.type.TypeMirror). However, subtypes should generally override this method (if needed).

This method behaves the same as QualifierHierarchy.isSubtypeQualifiersOnly(AnnotationMirror, AnnotationMirror), which calls this method. This method is for clients inside the framework, and it has protected access to prevent use by clients outside the framework. This makes it easy to find places where code outside the framework is ignoring Java basetypes -- at calls to QualifierHierarchy.isSubtypeQualifiersOnly(javax.lang.model.element.AnnotationMirror, javax.lang.model.element.AnnotationMirror).

Specified by:

isSubtypeQualifiers in class QualifierHierarchy

Parameters:

subAnno - possible subqualifier

superAnno - possible superqualifier

Returns:

true iff subQualifier is a subqualifier of, or equal to, superQualifier

isSubtypeWithElements

protected abstract boolean isSubtypeWithElements(AnnotationMirror subAnno,
 QualifierKind subKind,
 AnnotationMirror superAnno,
 QualifierKind superKind)

Returns true if subAnno is a subtype of superAnno. Both subAnno and superAnno are annotations with elements. subKind is a sub qualifier kind of superKind.

Parameters:

subAnno - possible subtype annotation; has elements

subKind - the QualifierKind of subAnno

superAnno - possible super annotation; has elements

superKind - the QualifierKind of superAnno

Returns:

true if subAnno is a subtype of superAnno

leastUpperBoundQualifiers

public final @Nullable AnnotationMirror leastUpperBoundQualifiers(AnnotationMirror a1,
 AnnotationMirror a2)

Description copied from class: QualifierHierarchy

Returns the least upper bound (LUB) of the qualifiers qualifier1 and qualifier2. Returns null if the qualifiers are not from the same qualifier hierarchy. Ignores Java basetypes.

Examples:

• For NonNull, leastUpperBound('Nullable', 'NonNull') ⇒ Nullable

Specified by:

leastUpperBoundQualifiers in class QualifierHierarchy

Parameters:

a1 - the first qualifier; may not be in the same hierarchy as qualifier2

a2 - the second qualifier; may not be in the same hierarchy as qualifier1

Returns:

the least upper bound of the qualifiers, or null if the qualifiers are from different hierarchies

leastUpperBoundWithElements

protected abstract AnnotationMirror leastUpperBoundWithElements(AnnotationMirror a1,
 QualifierKind qualifierKind1,
 AnnotationMirror a2,
 QualifierKind qualifierKind2,
 QualifierKind lubKind)

Returns the least upper bound of a1 and a2 in cases where the lub of qualifierKind1 and qualifierKind2 is a qualifier kind that has elements. If the lub of qualifierKind1 and qualifierKind2 does not have elements, then QualifierHierarchy.leastUpperBoundShallow(AnnotationMirror, TypeMirror, AnnotationMirror, TypeMirror) returns the correct AnnotationMirror without calling this method.

Parameters:

a1 - first annotation

qualifierKind1 - QualifierKind for a1

a2 - second annotation

qualifierKind2 - QualifierKind for a2

lubKind - the kind of the lub of qualifierKind1 and qualifierKind2

Returns:

the least upper bound of a1 and a2

greatestLowerBoundQualifiers

public final @Nullable AnnotationMirror greatestLowerBoundQualifiers(AnnotationMirror a1,
 AnnotationMirror a2)

Description copied from class: QualifierHierarchy

Returns the greatest lower bound for the qualifiers qualifier1 and qualifier2. Returns null if the qualifiers are not from the same qualifier hierarchy.

Specified by:

greatestLowerBoundQualifiers in class QualifierHierarchy

Parameters:

a1 - first qualifier

a2 - second qualifier

Returns:

greatest lower bound of the two annotations, or null if the two annotations are not from the same hierarchy

greatestLowerBoundWithElements

protected abstract AnnotationMirror greatestLowerBoundWithElements(AnnotationMirror a1,
 QualifierKind qualifierKind1,
 AnnotationMirror a2,
 QualifierKind qualifierKind2,
 QualifierKind glbKind)

Returns the greatest lower bound of a1 and a2 in cases where the glb of qualifierKind1 and qualifierKind2 is a qualifier kind that has elements. If the glb of qualifierKind1 and qualifierKind2 does not have elements, then QualifierHierarchy.greatestLowerBoundShallow(AnnotationMirror, TypeMirror, AnnotationMirror, TypeMirror) returns the correct AnnotationMirror without calling this method.

Parameters:

a1 - first annotation

qualifierKind1 - QualifierKind for a1

a2 - second annotation

qualifierKind2 - QualifierKind for a2

Returns:

the greatest lower bound between a1 and a2