org.checkerframework.common.reflection

Class ClassValAnnotatedTypeFactory.ClassValQualifierHierarchy

java.lang.Object

org.checkerframework.framework.type.ElementQualifierHierarchy

org.checkerframework.common.reflection.ClassValAnnotatedTypeFactory.ClassValQualifierHierarchy

All Implemented Interfaces:

QualifierHierarchy

Enclosing class:

ClassValAnnotatedTypeFactory

protected class ClassValAnnotatedTypeFactory.ClassValQualifierHierarchy
extends ElementQualifierHierarchy

The qualifier hierarchy for the ClassVal type system.

Field Summary

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

bottoms, bottomsMap, kindToElementlessQualifier, qualifierKindHierarchy, tops, topsMap

Constructor Summary

Constructors

Constructor and Description
ClassValQualifierHierarchy(Set<Class<? extends Annotation>> qualifierClasses, Elements elements) Creates a ClassValQualifierHierarchy from the given classes.

Method Summary

Modifier and Type	Method and Description
AnnotationMirror	greatestLowerBound(AnnotationMirror a1, AnnotationMirror a2) Returns the greatest lower bound for the qualifiers qualifier1 and qualifier2.
boolean	isSubtype(AnnotationMirror subAnno, AnnotationMirror superAnno) Tests whether subQualifier is equal to or a sub-qualifier of superQualifier, according to the type qualifier hierarchy.
AnnotationMirror	leastUpperBound(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 java.lang.Object

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

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

assertSameSize, assertSameSize, canHaveEmptyAnnotationSet, getWidth, greatestLowerBound, greatestLowerBounds, greatestLowerBounds, greatestLowerBoundsTypeVariable, greatestLowerBoundTypeVariable, isSubtype, isSubtype, isSubtype, isSubtypeTypeVariable, isSubtypeTypeVariable, leastUpperBound, leastUpperBounds, leastUpperBounds, leastUpperBoundsTypeVariable, leastUpperBoundTypeVariable, numberOfIterationsBeforeWidening, updateMappingToMutableSet, widenedUpperBound

Constructor Detail

ClassValQualifierHierarchy

public ClassValQualifierHierarchy(Set<Class<? extends Annotation>> qualifierClasses,
                                  Elements elements)

Creates a ClassValQualifierHierarchy from the given classes.

Parameters:

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

elements - element utils

Method Detail

leastUpperBound

public AnnotationMirror leastUpperBound(AnnotationMirror a1,
                                        AnnotationMirror a2)

Description copied from interface: 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.

Examples:

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

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

greatestLowerBound

public AnnotationMirror greatestLowerBound(AnnotationMirror a1,
                                           AnnotationMirror a2)

Description copied from interface: QualifierHierarchy

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

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

isSubtype

public boolean isSubtype(AnnotationMirror subAnno,
                         AnnotationMirror superAnno)

Description copied from interface: QualifierHierarchy

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

Parameters:

subAnno - possible subqualifier of superQualifier

superAnno - possible superqualifier of subQualifier

Returns:

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