Package org.checkerframework.common.reflection

Class MethodValAnnotatedTypeFactory.MethodValQualifierHierarchy

java.lang.Object

org.checkerframework.framework.type.QualifierHierarchy

org.checkerframework.framework.type.ElementQualifierHierarchy

org.checkerframework.common.reflection.MethodValAnnotatedTypeFactory.MethodValQualifierHierarchy

Enclosing class:

MethodValAnnotatedTypeFactory

protected class MethodValAnnotatedTypeFactory.MethodValQualifierHierarchy
extends ElementQualifierHierarchy

MethodValQualifierHierarchy.

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	MethodValQualifierHierarchy(Collection<Class<? extends Annotation>> qualifierClasses, Elements elements)	Creates a MethodValQualifierHierarchy from the given classes.

Method Summary

Modifier and Type	Method	Description
@Nullable AnnotationMirror	greatestLowerBoundQualifiers(AnnotationMirror a1, AnnotationMirror a2)	Returns the greatest lower bound for the qualifiers qualifier1 and qualifier2.
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.
@Nullable AnnotationMirror	leastUpperBoundQualifiers(AnnotationMirror a1, AnnotationMirror a2)	Returns the least upper bound (LUB) of the qualifiers qualifier1 and qualifier2.

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

MethodValQualifierHierarchy

protected MethodValQualifierHierarchy(Collection<Class<? extends Annotation>> qualifierClasses,
 Elements elements)

Creates a MethodValQualifierHierarchy from the given classes.

Parameters:

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

elements - element utils

Method Details

leastUpperBoundQualifiers

public @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

greatestLowerBoundQualifiers

public @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

isSubtypeQualifiers

public 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