org.checkerframework.checker.initialization

Class InitializationAnnotatedTypeFactory.InitializationQualifierHierarchy

java.lang.Object

org.checkerframework.framework.util.MultiGraphQualifierHierarchy

org.checkerframework.checker.initialization.InitializationAnnotatedTypeFactory.InitializationQualifierHierarchy

All Implemented Interfaces:

QualifierHierarchy

Direct Known Subclasses:

NullnessAnnotatedTypeFactory.NullnessQualifierHierarchy

Enclosing class:

InitializationAnnotatedTypeFactory<Value extends CFAbstractValue<Value>,Store extends InitializationStore<Value,Store>,Transfer extends InitializationTransfer<Value,Transfer,Store>,Flow extends CFAbstractAnalysis<Value,Store,Transfer>>

protected abstract class InitializationAnnotatedTypeFactory.InitializationQualifierHierarchy
extends MultiGraphQualifierHierarchy

The QualifierHierarchy for the initialization type system. Type systems extending the Initialization Checker should call methods isSubtypeInitialization(AnnotationMirror, AnnotationMirror) and leastUpperBoundInitialization(AnnotationMirror, AnnotationMirror) for appropriate qualifiers. See protected subclass NullnessQualifierHierarchy within class NullnessChecker for an example.

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, polyQualifiers, supertypesDirect, supertypesTransitive, tops

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InitializationQualifierHierarchy(MultiGraphQualifierHierarchy.MultiGraphFactory f, Object... arg) Create an InitializationQualifierHierarchy.

Method Summary

Modifier and Type	Method and Description
AnnotationMirror	greatestLowerBound(AnnotationMirror anno1, AnnotationMirror anno2) Returns the greatest lower bound for the qualifiers qualifier1 and qualifier2.
boolean	isSubtypeInitialization(AnnotationMirror rhs, AnnotationMirror lhs) Subtype testing for initialization annotations.
protected AnnotationMirror	leastUpperBoundInitialization(AnnotationMirror anno1, AnnotationMirror anno2) Compute the least upper bound of two initialization qualifiers.
protected TypeMirror	lubTypeFrame(TypeMirror a, TypeMirror b) Returns the least upper bound of two types.

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

addPolyRelations, findBottoms, findLub, findTops, finish, getBottomAnnotation, getBottomAnnotations, getPolymorphicAnnotation, getTopAnnotation, getTopAnnotations, isPolymorphicQualifier, isSubtype, isSubtype, isValid, leastUpperBound, toString, transitiveClosure

Methods inherited from class java.lang.Object

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

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

assertSameSize, assertSameSize, canHaveEmptyAnnotationSet, findAnnotationInHierarchy, findAnnotationInSameHierarchy, getWidth, greatestLowerBound, greatestLowerBounds, greatestLowerBounds, greatestLowerBoundsTypeVariable, greatestLowerBoundTypeVariable, isSubtype, isSubtype, isSubtypeTypeVariable, isSubtypeTypeVariable, leastUpperBound, leastUpperBounds, leastUpperBounds, leastUpperBoundsTypeVariable, leastUpperBoundTypeVariable, numberOfIterationsBeforeWidening, updateMappingToMutableSet, widenedUpperBound

Constructor Detail

InitializationQualifierHierarchy

protected InitializationQualifierHierarchy(MultiGraphQualifierHierarchy.MultiGraphFactory f,
                                           Object... arg)

Create an InitializationQualifierHierarchy.

Parameters:

f - a factory to create to create a GraphQualifierHierarchy

arg - seems to be ignored

Method Detail

isSubtypeInitialization

public boolean isSubtypeInitialization(AnnotationMirror rhs,
                                       AnnotationMirror lhs)

Subtype testing for initialization annotations. Will return false if either qualifier is not an initialization annotation. Subclasses should override isSubtype and call this method for initialization qualifiers.

leastUpperBoundInitialization

protected AnnotationMirror leastUpperBoundInitialization(AnnotationMirror anno1,
                                                         AnnotationMirror anno2)

Compute the least upper bound of two initialization qualifiers. Returns null if one of the qualifiers is not in the initialization hierarachy. Subclasses should override leastUpperBound and call this method for initialization qualifiers.

Parameters:

anno1 - an initialization qualifier

anno2 - an initialization qualifier

Returns:

the lub of anno1 and anno2

lubTypeFrame

protected TypeMirror lubTypeFrame(TypeMirror a,
                                  TypeMirror b)

Returns the least upper bound of two types.

greatestLowerBound

public AnnotationMirror greatestLowerBound(AnnotationMirror anno1,
                                           AnnotationMirror anno2)

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

Overrides:

greatestLowerBound in class MultiGraphQualifierHierarchy

Parameters:

anno1 - first qualifier

anno2 - second qualifier

Returns:

greatest lower bound of the two annotations or null if the two annotations are not from the same hierarchy