checkers.types

Class QualifierHierarchy

@NonNull java.lang.Object

checkers.types.QualifierHierarchy

Direct Known Subclasses:

MultiGraphQualifierHierarchy

public abstract class QualifierHierarchy
extends @NonNull Object

Represents a type qualifier hierarchy. All method parameter annotations need to be type qualifiers recognized within this hierarchy. This assumes that any particular annotated type in a program is annotated with at least one qualifier from the hierarchy.

Constructor Summary

Constructors

Constructor and Description
QualifierHierarchy()

Method Summary

Methods

Modifier and Type	Method and Description
@Nullable AnnotationMirror	findCorrespondingAnnotation(@Nullable AnnotationMirror aliased, Set<@Nullable AnnotationMirror> annotations)
abstract @Nullable AnnotationMirror	getBottomAnnotation(@Nullable AnnotationMirror start) Return the bottom for the given qualifier, that is, the qualifier that is a subtype of start but no further subtypes exist.
abstract Set<@Nullable AnnotationMirror>	getBottomAnnotations()
abstract @Nullable AnnotationMirror	getPolymorphicAnnotation(@Nullable AnnotationMirror start)
abstract @Nullable AnnotationMirror	getTopAnnotation(@Nullable AnnotationMirror start) Return the top qualifier for the given qualifier, that is, the qualifier that is a supertype of start but no further supertypes exist.
abstract Set<@Nullable AnnotationMirror>	getTopAnnotations()
abstract Set<@Nullable Name>	getTypeQualifiers() Returns the names of all type qualifiers in this type qualifier hierarchy.
abstract @Nullable AnnotationMirror	greatestLowerBound(@Nullable AnnotationMirror a1, @Nullable AnnotationMirror a2) Returns the greatest lower bound for the qualifiers a1 and a2.
Set<@Nullable AnnotationMirror>	greatestLowerBounds(Collection<@Nullable AnnotationMirror> annos1, Collection<@Nullable AnnotationMirror> annos2) Returns the type qualifiers that are the greatest lower bound of the qualifiers in annos1 and annos2.
abstract boolean	isSubtype(@Nullable AnnotationMirror anno1, @Nullable AnnotationMirror anno2) Tests whether anno1 is a sub-qualifier of anno2, according to the type qualifier hierarchy.
abstract boolean	isSubtype(Collection<@Nullable AnnotationMirror> rhs, Collection<@Nullable AnnotationMirror> lhs) Tests whether there is any annotation in lhs that is a super qualifier of some annotation in rhs.
abstract @Nullable AnnotationMirror	leastUpperBound(@Nullable AnnotationMirror a1, @Nullable AnnotationMirror a2) Returns the least upper bound for the qualifiers a1 and a2.
Set<@Nullable AnnotationMirror>	leastUpperBounds(Collection<@Nullable AnnotationMirror> annos1, Collection<@Nullable AnnotationMirror> annos2) Returns the type qualifiers that are the least upper bound of the qualifiers in annos1 and annos2.

Methods inherited from class java.lang.Object

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

Constructor Detail

QualifierHierarchy

public QualifierHierarchy()

Method Detail

getTopAnnotations

public abstract Set<@Nullable AnnotationMirror> getTopAnnotations()

Returns:

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

getTopAnnotation

public abstract @Nullable AnnotationMirror getTopAnnotation(@Nullable AnnotationMirror start)

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

getBottomAnnotation

public abstract @Nullable AnnotationMirror getBottomAnnotation(@Nullable AnnotationMirror start)

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

getBottomAnnotations

public abstract Set<@Nullable AnnotationMirror> getBottomAnnotations()

Returns:

the bottom type qualifier in the hierarchy

getPolymorphicAnnotation

public abstract @Nullable AnnotationMirror getPolymorphicAnnotation(@Nullable AnnotationMirror start)

Parameters:

start - Any qualifier from the type hierarchy.

Returns:

The polymorphic qualifier for that hierarchy

getTypeQualifiers

public abstract Set<@Nullable Name> getTypeQualifiers()

Returns the names of all type qualifiers in this type qualifier hierarchy. TODO: What is the relation to BaseTypeChecker.getSupportedTypeQualifiers()?

Returns:

the fully qualified name represented in this hierarchy

isSubtype

public abstract boolean isSubtype(@Nullable AnnotationMirror anno1,
                @Nullable AnnotationMirror anno2)

Tests whether anno1 is a sub-qualifier of anno2, according to the type qualifier hierarchy. This checks only the qualifiers, not the Java type.

Returns:

true iff anno1 is a sub qualifier of anno2

isSubtype

public abstract boolean isSubtype(Collection<@Nullable AnnotationMirror> rhs,
                Collection<@Nullable AnnotationMirror> lhs)

Tests whether there is any annotation in lhs that is a super qualifier of some annotation in rhs. lhs and rhs contain only the annotations, not the Java type.

Returns:

true iff an annotation in lhs is a super of one in rhs

leastUpperBound

public abstract @Nullable AnnotationMirror leastUpperBound(@Nullable AnnotationMirror a1,
                                         @Nullable AnnotationMirror a2)

Returns the least upper bound for the qualifiers a1 and a2. Examples: For NonNull, leastUpperBound('Nullable', 'NonNull') ==> Nullable For IGJ, leastUpperBound('Immutable', 'Mutable') ==> ReadOnly The two qualifiers have to be from the same qualifier hierarchy. Otherwise, null will be returned.

Returns:

the least restrictive qualifiers for both types

greatestLowerBound

public abstract @Nullable AnnotationMirror greatestLowerBound(@Nullable AnnotationMirror a1,
                                            @Nullable AnnotationMirror a2)

Returns the greatest lower bound for the qualifiers a1 and a2. The two qualifiers have to be from the same qualifier hierarchy. Otherwise, null will be returned.

Parameters:

a1 - First annotation

a2 - Second annotation

Returns:

Greatest lower bound of the two annotations

leastUpperBounds

public Set<@Nullable AnnotationMirror> leastUpperBounds(Collection<@Nullable AnnotationMirror> annos1,
                                               Collection<@Nullable AnnotationMirror> annos2)

Returns the type qualifiers that are the least upper bound of the qualifiers in annos1 and annos2.

This is necessary for determining the type of a conditional expression (?:), where the type of the expression is the least upper bound of the true and false clauses.

Returns:

the least upper bound of annos1 and annos2

greatestLowerBounds

public Set<@Nullable AnnotationMirror> greatestLowerBounds(Collection<@Nullable AnnotationMirror> annos1,
                                                  Collection<@Nullable AnnotationMirror> annos2)

Returns the type qualifiers that are the greatest lower bound of the qualifiers in annos1 and annos2. The two qualifiers have to be from the same qualifier hierarchy. Otherwise, null will be returned.

Parameters:

annos1 - First collection of qualifiers

annos2 - Second collection of qualifiers

Returns:

Greatest lower bound of the two collections of qualifiers

findCorrespondingAnnotation

public @Nullable AnnotationMirror findCorrespondingAnnotation(@Nullable AnnotationMirror aliased,
                                                     Set<@Nullable AnnotationMirror> annotations)