Package org.checkerframework.framework.type

Class ElementQualifierHierarchy

java.lang.Object

org.checkerframework.framework.type.QualifierHierarchy

org.checkerframework.framework.type.ElementQualifierHierarchy

Direct Known Subclasses:

AccumulationAnnotatedTypeFactory.AccumulationQualifierHierarchy, ClassValAnnotatedTypeFactory.ClassValQualifierHierarchy, MethodValAnnotatedTypeFactory.MethodValQualifierHierarchy, MostlyNoElementQualifierHierarchy, UpperBoundAnnotatedTypeFactory.UpperBoundQualifierHierarchy

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

A 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

Fields

Modifier and Type	Field	Description
protected final AnnotationMirrorSet	bottoms	The set of bottom annotation mirrors.
protected final Map<QualifierKind,AnnotationMirror>	bottomsMap	A mapping from bottom QualifierKinds to their corresponding AnnotationMirror.
protected final Map<QualifierKind,AnnotationMirror>	kindToElementlessQualifier	A mapping from QualifierKind to AnnotationMirror for all qualifiers whose annotations do not have elements.
protected final QualifierKindHierarchy	qualifierKindHierarchy	QualifierKindHierarchy.
protected final AnnotationMirrorSet	tops	The set of top annotation mirrors.
protected final Map<QualifierKind,AnnotationMirror>	topsMap	A mapping from top QualifierKinds to their corresponding AnnotationMirror.

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

atypeFactory

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected Map<QualifierKind,AnnotationMirror>	createBottomsMap()	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>	createElementlessQualifierMap()	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 the QualifierKindHierarchy.
protected Map<QualifierKind,AnnotationMirror>	createTopsMap()	Creates a mapping from QualifierKind to AnnotationMirror, where the QualifierKind is top and the AnnotationMirror is top in their respective hierarchies.
@Nullable AnnotationMirror	findAnnotationInHierarchy(Collection<? extends AnnotationMirror> annos, AnnotationMirror top)	Returns the annotation in qualifiers that is in the hierarchy for which top is top.
@Nullable AnnotationMirror	findAnnotationInSameHierarchy(Collection<? extends AnnotationMirror> annos, AnnotationMirror annotationMirror)	Returns the annotation in qualifiers that is in the same hierarchy as qualifier.
AnnotationMirror	getBottomAnnotation(AnnotationMirror start)	Return the bottom for the given qualifier, that is, the qualifier that is a subtype of qualifier but no further subtypes exist.
AnnotationMirrorSet	getBottomAnnotations()	Returns the bottom type qualifiers in the hierarchy.
@Nullable AnnotationMirror	getPolymorphicAnnotation(AnnotationMirror start)	Returns the polymorphic qualifier for the hierarchy containing qualifier, or null if there is no polymorphic qualifier in that hierarchy.
protected QualifierKind	getQualifierKind(@CanonicalName String name)	Returns the qualifier kind for the annotation with the canonical name name.
protected QualifierKind	getQualifierKind(AnnotationMirror anno)	Returns the qualifier kind for the given annotation.
AnnotationMirror	getTopAnnotation(AnnotationMirror start)	Return the top qualifier for the given qualifier, that is, the qualifier that is a supertype of qualifier but no further supertypes exist.
AnnotationMirrorSet	getTopAnnotations()	Returns the top (ultimate super) type qualifiers in the type system.
boolean	isPolymorphicQualifier(AnnotationMirror qualifier)	Returns true if the qualifier is a polymorphic qualifier; otherwise, returns false.
boolean	isValid()	Determine whether this QualifierHierarchy is valid.

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

assertSameSize, assertSameSize, canHaveEmptyAnnotationSet, getWidth, greatestLowerBoundQualifiers, greatestLowerBoundQualifiersOnly, greatestLowerBoundShallow, greatestLowerBoundsShallow, isSubtypeQualifiers, isSubtypeQualifiersOnly, isSubtypeShallow, isSubtypeShallow, isSubtypeShallow, isSubtypeShallow, leastUpperBoundQualifiers, leastUpperBoundQualifiersOnly, leastUpperBoundShallow, leastUpperBoundsShallow, numberOfIterationsBeforeWidening, updateMappingToMutableSet, widenedUpperBound

Methods inherited from class java.lang.Object

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

Field Details

qualifierKindHierarchy

protected final QualifierKindHierarchy qualifierKindHierarchy

QualifierKindHierarchy.

topsMap

protected final Map<QualifierKind,AnnotationMirror> topsMap

A mapping from top QualifierKinds to their corresponding AnnotationMirror.

tops

protected final AnnotationMirrorSet tops

The set of top annotation mirrors.

bottomsMap

protected final Map<QualifierKind,AnnotationMirror> bottomsMap

A mapping from bottom QualifierKinds to their corresponding AnnotationMirror.

bottoms

protected final AnnotationMirrorSet bottoms

The set of bottom annotation mirrors.

kindToElementlessQualifier

protected final Map<QualifierKind,AnnotationMirror> 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,
 GenericAnnotatedTypeFactory<?,?,?,?> atypeFactory)

Creates a ElementQualifierHierarchy 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

isValid

public boolean isValid()

Description copied from class: QualifierHierarchy

Determine whether this QualifierHierarchy is valid.

Overrides:

isValid in class QualifierHierarchy

Returns:

true if this QualifierHierarchy is valid

createQualifierKindHierarchy

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

Create the QualifierKindHierarchy. (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

protected QualifierKind getQualifierKind(AnnotationMirror anno)

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

protected QualifierKind getQualifierKind(@CanonicalName String name)

Returns the qualifier kind for the annotation with the canonical name name.

Parameters:

name - fully qualified annotation name

Returns:

the qualifier kind for the annotation named name

getTopAnnotations

public AnnotationMirrorSet getTopAnnotations()

Description copied from class: QualifierHierarchy

Returns the top (ultimate super) type qualifiers in the type system. The size of this set is equal to QualifierHierarchy.getWidth().

Specified by:

getTopAnnotations in class QualifierHierarchy

Returns:

the top (ultimate super) type qualifiers in the type system

getTopAnnotation

public AnnotationMirror getTopAnnotation(AnnotationMirror start)

Description copied from class: QualifierHierarchy

Return the top qualifier for the given qualifier, that is, the qualifier that is a supertype of qualifier but no further supertypes exist.

Specified by:

getTopAnnotation in class QualifierHierarchy

Parameters:

start - any qualifier from one of the qualifier hierarchies represented by this

Returns:

the top qualifier of qualifier's hierarchy

getBottomAnnotations

public AnnotationMirrorSet getBottomAnnotations()

Description copied from class: QualifierHierarchy

Returns the bottom type qualifiers in the hierarchy. The size of this set is equal to QualifierHierarchy.getWidth().

Specified by:

getBottomAnnotations in class QualifierHierarchy

Returns:

the bottom type qualifiers in the hierarchy

getPolymorphicAnnotation

public @Nullable AnnotationMirror getPolymorphicAnnotation(AnnotationMirror start)

Description copied from class: QualifierHierarchy

Returns the polymorphic qualifier for the hierarchy containing qualifier, or null if there is no polymorphic qualifier in that hierarchy.

Specified by:

getPolymorphicAnnotation in class QualifierHierarchy

Parameters:

start - any qualifier from one of the qualifier hierarchies represented by this

Returns:

the polymorphic qualifier for the hierarchy containing qualifier, or null if there is no polymorphic qualifier in that hierarchy

isPolymorphicQualifier

public boolean isPolymorphicQualifier(AnnotationMirror qualifier)

Description copied from class: QualifierHierarchy

Returns true if the qualifier is a polymorphic qualifier; otherwise, returns false.

Specified by:

isPolymorphicQualifier in class QualifierHierarchy

Parameters:

qualifier - qualifier

Returns:

true if the qualifier is a polymorphic qualifier; otherwise, returns false.

getBottomAnnotation

public AnnotationMirror getBottomAnnotation(AnnotationMirror start)

Description copied from class: QualifierHierarchy

Return the bottom for the given qualifier, that is, the qualifier that is a subtype of qualifier but no further subtypes exist.

Specified by:

getBottomAnnotation in class QualifierHierarchy

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 class: QualifierHierarchy

Returns the annotation in qualifiers that is in the same hierarchy as qualifier.

The default implementation calls QualifierHierarchy.getTopAnnotation(AnnotationMirror) and then calls QualifierHierarchy.findAnnotationInHierarchy(Collection, AnnotationMirror). So, if qualifier is a top qualifier, then call QualifierHierarchy.findAnnotationInHierarchy(Collection, AnnotationMirror) directly is faster.

Overrides:

findAnnotationInSameHierarchy in class QualifierHierarchy

Parameters:

annos - set of annotations to search

annotationMirror - 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 class: QualifierHierarchy

Returns the annotation in qualifiers that is in the hierarchy for which top is top.

Overrides:

findAnnotationInHierarchy in class QualifierHierarchy

Parameters:

annos - set of annotations to search

top - 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