Package org.checkerframework.framework.type

Class NoElementQualifierHierarchy

java.lang.Object

org.checkerframework.framework.type.NoElementQualifierHierarchy

All Implemented Interfaces:

QualifierHierarchy

Direct Known Subclasses:

AliasingAnnotatedTypeFactory.AliasingQualifierHierarchy

@AnnotatedFor("nullness")
public class NoElementQualifierHierarchy
extends Object
implements 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.

Constructor Summary

Constructors

Constructor	Description
NoElementQualifierHierarchy(Collection<Class<? extends Annotation>> qualifierClasses, Elements elements)	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.
Set<? extends AnnotationMirror>	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.
Set<? extends AnnotationMirror>	getTopAnnotations()	Returns the top (ultimate super) type qualifiers in the type system.
@Nullable AnnotationMirror	greatestLowerBound(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	isSubtype(AnnotationMirror subAnno, AnnotationMirror superAnno)	Tests whether subQualifier is equal to or a sub-qualifier of superQualifier, according to the type qualifier hierarchy.
@Nullable AnnotationMirror	leastUpperBound(AnnotationMirror a1, AnnotationMirror a2)	Returns the least upper bound (LUB) of the qualifiers qualifier1 and qualifier2.

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, isValid, leastUpperBounds, numberOfIterationsBeforeWidening, updateMappingToMutableSet, widenedUpperBound

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)

Creates a NoElementQualifierHierarchy from the given classes.

Parameters:

qualifierClasses - classes of annotations that are the qualifiers

elements - element utils

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 interface: 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.

Specified by:

findAnnotationInSameHierarchy in interface 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 interface: QualifierHierarchy

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

Specified by:

findAnnotationInHierarchy in interface 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 Set<? extends AnnotationMirror> getTopAnnotations()

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

Returns:

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

getTopAnnotation

public AnnotationMirror getTopAnnotation(AnnotationMirror start)

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

Parameters:

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

Returns:

the top qualifier of qualifier's hierarchy

getBottomAnnotations

public Set<? extends AnnotationMirror> getBottomAnnotations()

Description copied from interface: QualifierHierarchy

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

Specified by:

getBottomAnnotations in interface QualifierHierarchy

Returns:

the bottom type qualifiers in the hierarchy

getBottomAnnotation

public AnnotationMirror getBottomAnnotation(AnnotationMirror start)

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

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

Specified by:

isPolymorphicQualifier in interface QualifierHierarchy

Parameters:

qualifier - qualifier

Returns:

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

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.

Specified by:

isSubtype in interface QualifierHierarchy

Parameters:

subAnno - possible subqualifier of superQualifier

superAnno - possible superqualifier of subQualifier

Returns:

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

leastUpperBound

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

Specified by:

leastUpperBound in interface 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

greatestLowerBound

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

Specified by:

greatestLowerBound in interface 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