org.checkerframework.checker.nullness

Class NullnessAnnotatedTypeFactory.NullnessQualifierHierarchy

java.lang.Object

org.checkerframework.framework.type.QualifierHierarchy

org.checkerframework.framework.util.MultiGraphQualifierHierarchy

org.checkerframework.checker.initialization.InitializationAnnotatedTypeFactory.InitializationQualifierHierarchy

org.checkerframework.checker.nullness.NullnessAnnotatedTypeFactory.NullnessQualifierHierarchy

Enclosing class:

NullnessAnnotatedTypeFactory

protected class NullnessAnnotatedTypeFactory.NullnessQualifierHierarchy
extends InitializationAnnotatedTypeFactory.InitializationQualifierHierarchy

Nested Class Summary

Nested classes/interfaces inherited from class org.checkerframework.framework.util.MultiGraphQualifierHierarchy

MultiGraphQualifierHierarchy.MultiGraphFactory

Field Summary

Fields inherited from class org.checkerframework.framework.util.MultiGraphQualifierHierarchy

bottoms, polymorphicQualifier, polyQualifiers, supertypesGraph, supertypesMap, tops, typeQualifiers

Constructor Summary

Constructors

Constructor and Description
NullnessQualifierHierarchy(MultiGraphQualifierHierarchy.MultiGraphFactory f, Object[] arg)

Method Summary

Modifier and Type	Method and Description
boolean	isSubtype(AnnotationMirror rhs, AnnotationMirror lhs) Tests whether rhs is equal to or a sub-qualifier of lhs, according to the type qualifier hierarchy.
AnnotationMirror	leastUpperBound(AnnotationMirror a1, AnnotationMirror a2) Returns the least upper bound for the qualifiers a1 and a2.

Methods inherited from class org.checkerframework.checker.initialization.InitializationAnnotatedTypeFactory.InitializationQualifierHierarchy

greatestLowerBound, isSubtypeInitialization, leastUpperBoundInitialization, lubTypeFrame

Methods inherited from class org.checkerframework.framework.util.MultiGraphQualifierHierarchy

addPolyRelations, buildFullMap, findBottoms, findLub, findTops, finish, getBottomAnnotation, getBottomAnnotations, getPolymorphicAnnotation, getTopAnnotation, getTopAnnotations, getTypeQualifiers, greatestLowerBoundTypeVariable, isSubtype, isSubtypeTypeVariable, isSubtypeTypeVariable, leastUpperBoundTypeVariable, toString

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

canHaveEmptyAnnotationSet, findAnnotationInHierarchy, findAnnotationInSameHierarchy, findCorrespondingAnnotation, getAnnotationInHierarchy, getWidth, greatestLowerBound, greatestLowerBounds, greatestLowerBounds, greatestLowerBoundsTypeVariable, isSubtype, isSubtype, isValid, leastUpperBound, leastUpperBounds, leastUpperBounds, leastUpperBoundsTypeVariable, replacePolyAll, updateMappingToMutableSet

Methods inherited from class java.lang.Object

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

Constructor Detail

NullnessQualifierHierarchy

public NullnessQualifierHierarchy(MultiGraphQualifierHierarchy.MultiGraphFactory f,
                                  Object[] arg)

Method Detail

isSubtype

public boolean isSubtype(AnnotationMirror rhs,
                         AnnotationMirror lhs)

Description copied from class: MultiGraphQualifierHierarchy

Tests whether rhs is equal to or a sub-qualifier of lhs, according to the type qualifier hierarchy. This checks only the qualifiers, not the Java type.

Most qualifiers have no value fields. However, two annotations with values are subtype of each other only if they have the same values. i.e. I(m) is a subtype of I(n) iff m = n

When client specifies an annotation, a1, to be a subtype of annotation with values, a2, then a1 is a subtype of all instances of a2 regardless of a2 values.

Overrides:

isSubtype in class MultiGraphQualifierHierarchy

Parameters:

rhs - the right-hand side, i.e. the sub qualifier

lhs - the left-hand side, i.e. the super qualifier

Returns:

true iff rhs is a sub qualifier of lhs

leastUpperBound

public AnnotationMirror leastUpperBound(AnnotationMirror a1,
                                        AnnotationMirror a2)

Description copied from class: QualifierHierarchy

Returns the least upper bound for the qualifiers a1 and a2.

Examples:

• For NonNull, leastUpperBound('Nullable', 'NonNull') ⇒ Nullable

The two qualifiers have to be from the same qualifier hierarchy. Otherwise, null will be returned.

Overrides:

leastUpperBound in class MultiGraphQualifierHierarchy

Returns:

the least restrictive qualifiers for both types