Package org.checkerframework.framework.type

Class NoElementQualifierHierarchy

java.lang.Object

org.checkerframework.framework.type.QualifierHierarchy

org.checkerframework.framework.type.NoElementQualifierHierarchy

Direct Known Subclasses:

AliasingAnnotatedTypeFactory.AliasingQualifierHierarchy

@AnnotatedFor("nullness")
public class NoElementQualifierHierarchy
extends QualifierHierarchy

A QualifierHierarchy where no qualifier has arguments; that is, no qualifier is represented by an annotation with elements. The meta-annotation SubtypeOf specifies the subtyping relationships.

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

Field Summary

Fields

Modifier and Type	Field	Description
protected final AnnotationMirrorSet	bottoms	Set of bottom annotation mirrors.
protected final Map<QualifierKind,AnnotationMirror>	kindToAnnotationMirror	Mapping from QualifierKind to its corresponding AnnotationMirror.
protected final QualifierKindHierarchy	qualifierKindHierarchy	QualifierKindHierarchy.
protected final Set<? extends AnnotationMirror>	qualifiers	Set of all annotations in all the hierarchies.
protected final AnnotationMirrorSet	tops	Set of top annotation mirrors.

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

atypeFactory

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected Map<QualifierKind,AnnotationMirror>	createAnnotationMirrors(Elements elements)	Creates and returns a mapping from qualifier kind to an annotation mirror created from the qualifier kind's annotation class.
protected AnnotationMirrorSet	createBottoms()	Creates and returns the unmodifiable set of bottom AnnotationMirrors.
protected QualifierKindHierarchy	createQualifierKindHierarchy(Collection<Class<? extends Annotation>> qualifierClasses)	Create the QualifierKindHierarchy.
protected AnnotationMirrorSet	createTops()	Creates and returns the unmodifiable set of top AnnotationMirrors.
@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(AnnotationMirror anno)	Returns the QualifierKind 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.
@Nullable AnnotationMirror	greatestLowerBoundQualifiers(AnnotationMirror a1, AnnotationMirror a2)	Returns the greatest lower bound for the qualifiers qualifier1 and qualifier2.
boolean	isPolymorphicQualifier(AnnotationMirror qualifier)	Returns true if the qualifier is a polymorphic qualifier; otherwise, returns false.
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.QualifierHierarchy

assertSameSize, assertSameSize, canHaveEmptyAnnotationSet, getWidth, greatestLowerBoundQualifiersOnly, greatestLowerBoundShallow, greatestLowerBoundsShallow, isSubtypeQualifiersOnly, isSubtypeShallow, isSubtypeShallow, isSubtypeShallow, isSubtypeShallow, isValid, 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.

tops

protected final AnnotationMirrorSet tops

Set of top annotation mirrors.

bottoms

protected final AnnotationMirrorSet bottoms

Set of bottom annotation mirrors.

kindToAnnotationMirror

protected final Map<QualifierKind,AnnotationMirror> kindToAnnotationMirror

Mapping from QualifierKind to its corresponding AnnotationMirror.

qualifiers

protected final Set<? extends AnnotationMirror> qualifiers

Set of all annotations in all the hierarchies.

Constructor Details

NoElementQualifierHierarchy

public NoElementQualifierHierarchy(Collection<Class<? extends Annotation>> qualifierClasses,
 Elements elements,
 GenericAnnotatedTypeFactory<?,?,?,?> atypeFactory)

Creates a NoElementQualifierHierarchy from the given classes.

Parameters:

qualifierClasses - classes of annotations that are the qualifiers

elements - element utils

atypeFactory - the associated type factory

Method Details

createQualifierKindHierarchy

protected QualifierKindHierarchy createQualifierKindHierarchy(@UnderInitialization NoElementQualifierHierarchy 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

Returns:

the newly created qualifier kind hierarchy

createAnnotationMirrors

@RequiresNonNull("this.qualifierKindHierarchy")
protected Map<QualifierKind,AnnotationMirror> createAnnotationMirrors(@UnderInitialization NoElementQualifierHierarchy this,
 Elements elements)

Creates and returns a mapping from qualifier kind to an annotation mirror created from the qualifier kind's annotation class.

Parameters:

elements - element utils

Returns:

a mapping from qualifier kind to its annotation mirror

createTops

@RequiresNonNull({"this.kindToAnnotationMirror","this.qualifierKindHierarchy"})
protected AnnotationMirrorSet createTops(@UnderInitialization NoElementQualifierHierarchy this)

Creates and returns the unmodifiable set of top AnnotationMirrors.

Returns:

the unmodifiable set of top AnnotationMirrors

createBottoms

@RequiresNonNull({"this.kindToAnnotationMirror","this.qualifierKindHierarchy"})
protected AnnotationMirrorSet createBottoms(@UnderInitialization NoElementQualifierHierarchy this)

Creates and returns the unmodifiable set of bottom AnnotationMirrors.

Returns:

the unmodifiable set of bottom AnnotationMirrors

getQualifierKind

protected QualifierKind getQualifierKind(AnnotationMirror anno)

Returns the QualifierKind for the given annotation.

Parameters:

anno - an annotation that is a qualifier in this

Returns:

the QualifierKind for the given annotation

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

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

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

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.

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

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