Package org.checkerframework.checker.units

Class UnitsAnnotatedTypeFactory.UnitsQualifierHierarchy

java.lang.Object

org.checkerframework.framework.type.ElementQualifierHierarchy

org.checkerframework.framework.type.MostlyNoElementQualifierHierarchy

org.checkerframework.checker.units.UnitsAnnotatedTypeFactory.UnitsQualifierHierarchy

All Implemented Interfaces:

QualifierHierarchy

Enclosing class:

UnitsAnnotatedTypeFactory

@AnnotatedFor("nullness")
protected class UnitsAnnotatedTypeFactory.UnitsQualifierHierarchy
extends MostlyNoElementQualifierHierarchy

Qualifier Hierarchy for the Units Checker.

Field Summary

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

bottoms, bottomsMap, kindToElementlessQualifier, qualifierKindHierarchy, tops, topsMap

Constructor Summary

Constructors

Constructor	Description
UnitsQualifierHierarchy()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected QualifierKindHierarchy	createQualifierKindHierarchy(Collection<Class<? extends Annotation>> qualifierClasses)	Create the QualifierKindHierarchy.
protected 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.
protected boolean	isSubtypeWithElements(AnnotationMirror subAnno, QualifierKind subKind, AnnotationMirror superAnno, QualifierKind superKind)	Returns true if subAnno is a subtype of superAnno.
protected 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.MostlyNoElementQualifierHierarchy

greatestLowerBound, isSubtype, leastUpperBound

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

createBottomsMap, createElementlessQualifierMap, 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

getWidth, greatestLowerBounds, isSubtype, leastUpperBounds, numberOfIterationsBeforeWidening, updateMappingToMutableSet, widenedUpperBound

Constructor Details

UnitsQualifierHierarchy

public UnitsQualifierHierarchy()

Constructor.

Method Details

createQualifierKindHierarchy

protected QualifierKindHierarchy createQualifierKindHierarchy(@UnderInitialization UnitsAnnotatedTypeFactory.UnitsQualifierHierarchy this,
 Collection<Class<? extends Annotation>> qualifierClasses)

Description copied from class: ElementQualifierHierarchy

Create the QualifierKindHierarchy. (Subclasses may override to return a subclass of QualifierKindHierarchy.)

Overrides:

createQualifierKindHierarchy in class ElementQualifierHierarchy

Parameters:

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

Returns:

the newly created qualifier kind hierarchy

isSubtypeWithElements

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

Description copied from class: MostlyNoElementQualifierHierarchy

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.

Specified by:

isSubtypeWithElements in class MostlyNoElementQualifierHierarchy

Parameters:

subAnno - possible subtype annotation; has elements

subKind - QualifierKind of subAnno

superAnno - possible super annotation; has elements

superKind - QualifierKind of superAnno

Returns:

true if subAnno is a subtype of superAnno

leastUpperBoundWithElements

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

Description copied from class: MostlyNoElementQualifierHierarchy

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 MostlyNoElementQualifierHierarchy.leastUpperBound(AnnotationMirror, AnnotationMirror) returns the correct AnnotationMirror without calling this method.

Specified by:

leastUpperBoundWithElements in class MostlyNoElementQualifierHierarchy

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

greatestLowerBoundWithElements

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

Description copied from class: MostlyNoElementQualifierHierarchy

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 MostlyNoElementQualifierHierarchy.greatestLowerBound(AnnotationMirror, AnnotationMirror) returns the correct AnnotationMirror without calling this method.

Specified by:

greatestLowerBoundWithElements in class MostlyNoElementQualifierHierarchy

Parameters:

a1 - first annotation

qualifierKind1 - QualifierKind for a1

a2 - second annotation

qualifierKind2 - QualifierKind for a2

Returns:

the greatest lower bound between a1 and a2