org.checkerframework.framework.util

Class GraphQualifierHierarchy

java.lang.Object

org.checkerframework.framework.util.MultiGraphQualifierHierarchy

org.checkerframework.framework.util.GraphQualifierHierarchy

All Implemented Interfaces:

QualifierHierarchy

Direct Known Subclasses:

FenumAnnotatedTypeFactory.FenumQualifierHierarchy, UnitsAnnotatedTypeFactory.UnitsQualifierHierarchy

public class GraphQualifierHierarchy
extends MultiGraphQualifierHierarchy

Represents the type qualifier hierarchy of a type system.

This class is immutable and can be only created through MultiGraphQualifierHierarchy.MultiGraphFactory.

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

Constructor and Description
GraphQualifierHierarchy(MultiGraphQualifierHierarchy.MultiGraphFactory f, AnnotationMirror bottom)

Method Summary

Modifier and Type	Method and Description
protected void	finish(QualifierHierarchy qualHierarchy, Map<AnnotationMirror,Set<AnnotationMirror>> fullMap, Map<AnnotationMirror,AnnotationMirror> polyQualifiers, Set<AnnotationMirror> tops, Set<AnnotationMirror> bottoms, Object... args) Method to finalize the qualifier hierarchy before it becomes unmodifiable.
Set<? extends AnnotationMirror>	getBottomAnnotations() Returns the bottom type qualifiers in the hierarchy.
Set<? extends AnnotationMirror>	getTopAnnotations() Returns the top qualifiers for this hierarchy.
boolean	isSubtype(Collection<? extends AnnotationMirror> rhs, Collection<? extends AnnotationMirror> lhs) Tests whether all qualifiers in subQualifiers are a subqualifier or equal to the qualifier in the same hierarchy in superQualifiers.

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

addPolyRelations, findBottoms, findLub, findTops, getBottomAnnotation, getPolymorphicAnnotation, getTopAnnotation, greatestLowerBound, isPolymorphicQualifier, 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

GraphQualifierHierarchy

public GraphQualifierHierarchy(MultiGraphQualifierHierarchy.MultiGraphFactory f,
                               AnnotationMirror bottom)

Method Detail

finish

protected void finish(QualifierHierarchy qualHierarchy,
                      Map<AnnotationMirror,Set<AnnotationMirror>> fullMap,
                      Map<AnnotationMirror,AnnotationMirror> polyQualifiers,
                      Set<AnnotationMirror> tops,
                      Set<AnnotationMirror> bottoms,
                      Object... args)

Description copied from class: MultiGraphQualifierHierarchy

Method to finalize the qualifier hierarchy before it becomes unmodifiable. The parameters pass all fields and allow modification.

Overrides:

finish in class MultiGraphQualifierHierarchy

getTopAnnotations

public Set<? extends AnnotationMirror> getTopAnnotations()

Returns the top qualifiers for this hierarchy. Returns multiple values for a compound checker (such as the Nullness Checker).

The top qualifier is inferred from the hierarchy, as being the only one without any super qualifiers

Specified by:

getTopAnnotations in interface QualifierHierarchy

Overrides:

getTopAnnotations in class MultiGraphQualifierHierarchy

Returns:

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

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

Overrides:

getBottomAnnotations in class MultiGraphQualifierHierarchy

Returns:

the bottom type qualifiers in the hierarchy

isSubtype

public boolean isSubtype(Collection<? extends AnnotationMirror> rhs,
                         Collection<? extends AnnotationMirror> lhs)

Description copied from interface: QualifierHierarchy

Tests whether all qualifiers in subQualifiers are a subqualifier or equal to the qualifier in the same hierarchy in superQualifiers.

Specified by:

isSubtype in interface QualifierHierarchy

Overrides:

isSubtype in class MultiGraphQualifierHierarchy

Parameters:

rhs - set of qualifiers; exactly one per hierarchy

lhs - set of qualifiers; exactly one per hierarchy

Returns:

true iff all qualifiers in subQualifiers are a subqualifier or equal to the qualifier in the same hierarchy in superQualifiers