MultiGraphQualifierHierarchy (checker-framework 3.6.0 API)

java.lang.Object
- org.checkerframework.framework.util.MultiGraphQualifierHierarchy

All Implemented Interfaces:

QualifierHierarchy

Direct Known Subclasses:

AccumulationAnnotatedTypeFactory.AccumulationQualifierHierarchy, AliasingAnnotatedTypeFactory.AliasingQualifierHierarchy, ClassValAnnotatedTypeFactory.ClassValQualifierHierarchy, GraphQualifierHierarchy, InitializationAnnotatedTypeFactory.InitializationQualifierHierarchy, MethodValAnnotatedTypeFactory.MethodValQualifierHierarchy, UpperBoundAnnotatedTypeFactory.UpperBoundQualifierHierarchy
```
public class MultiGraphQualifierHierarchy
extends Object
implements QualifierHierarchy
```
Represents the type qualifier hierarchy of a type system that supports multiple separate subtype hierarchies.
This class is immutable and can be only created through MultiGraphQualifierHierarchy.MultiGraphFactory.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MultiGraphQualifierHierarchy.MultiGraphFactory
Factory used to create an instance of GraphQualifierHierarchy.

Nested Classes
Modifier and Type	Class and Description
`static class`	`MultiGraphQualifierHierarchy.MultiGraphFactory` Factory used to create an instance of `GraphQualifierHierarchy`.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Set<AnnotationMirror>`	`bottoms` The bottom qualifiers of the type hierarchies.
`protected Map<AnnotationMirror,AnnotationMirror>`	`polyQualifiers` See `MultiGraphQualifierHierarchy.MultiGraphFactory.polyQualifiers`.
`protected Map<AnnotationMirror,Set<AnnotationMirror>>`	`supertypesDirect` The declared, direct supertypes for each qualifier, without added transitive relations.
`protected Map<AnnotationMirror,Set<AnnotationMirror>>`	`supertypesTransitive` The transitive closure of the supertypesDirect.
`protected Set<AnnotationMirror>`	`tops` The top qualifiers of the individual type hierarchies.

Constructor Summary

Constructors
Constructor and Description
`MultiGraphQualifierHierarchy(MultiGraphQualifierHierarchy.MultiGraphFactory f)`
`MultiGraphQualifierHierarchy(MultiGraphQualifierHierarchy.MultiGraphFactory f, Object... args)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addPolyRelations(QualifierHierarchy qualHierarchy, Map<AnnotationMirror,Set<AnnotationMirror>> fullMap, Map<AnnotationMirror,AnnotationMirror> polyQualifiers, Set<AnnotationMirror> tops, Set<AnnotationMirror> bottoms)` Add the relationships for polymorphic qualifiers.
`protected Set<AnnotationMirror>`	`findBottoms(Map<AnnotationMirror,Set<AnnotationMirror>> supertypes)` Infer the bottoms of the subtype hierarchy.
`protected AnnotationMirror`	`findLub(AnnotationMirror a1, AnnotationMirror a2)` Finds and returns the Least Upper Bound (LUB) of two annotation mirrors a1 and a2 by recursively climbing the qualifier hierarchy of a1 until one of them is a subtype of the other, or returns null if no subtype relationships can be found.
`protected Set<AnnotationMirror>`	`findTops(Map<AnnotationMirror,Set<AnnotationMirror>> supertypes)` Infer the tops of the subtype hierarchy.
`protected void`	`finish(QualifierHierarchy qualHierarchy, Map<AnnotationMirror,Set<AnnotationMirror>> supertypesTransitive, Map<AnnotationMirror,AnnotationMirror> polyQualifiers, Set<AnnotationMirror> tops, Set<AnnotationMirror> bottoms, Object... args)` Method to finalize the qualifier hierarchy before it becomes unmodifiable.
`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.
`AnnotationMirror`	`getPolymorphicAnnotation(AnnotationMirror start)` Returns the polymorphic qualifier for the hierarchy containing `qualifier`, or `null` if there is no polymorphic qualifier in that hierarchy.
`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.
`AnnotationMirror`	`greatestLowerBound(AnnotationMirror a1, AnnotationMirror a2)` Returns the greatest lower bound for the qualifiers qualifier1 and qualifier2.
`boolean`	`isPolymorphicQualifier(AnnotationMirror qual)` 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.
`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`.
`boolean`	`isValid()` Determine whether this is valid.
`AnnotationMirror`	`leastUpperBound(AnnotationMirror a1, AnnotationMirror a2)` Returns the least upper bound (LUB) of the qualifiers `qualifier1` and `qualifier2`.
`String`	`toString()`
`protected Map<AnnotationMirror,Set<AnnotationMirror>>`	`transitiveClosure(Map<AnnotationMirror,Set<AnnotationMirror>> supertypes)` Computes the transitive closure of the given map and returns it.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - supertypesDirect
```
protected final Map<AnnotationMirror,Set<AnnotationMirror>> supertypesDirect
```
    The declared, direct supertypes for each qualifier, without added transitive relations. Immutable after construction finishes. No polymorphic qualifiers are contained in this map.
    
    See Also:
    
    MultiGraphQualifierHierarchy.MultiGraphFactory.supertypesDirect
  - supertypesTransitive
```
protected final Map<AnnotationMirror,Set<AnnotationMirror>> supertypesTransitive
```
    The transitive closure of the supertypesDirect. Immutable after construction finishes.
  - tops
```
protected final Set<AnnotationMirror> tops
```
    The top qualifiers of the individual type hierarchies.
  - bottoms
```
protected final Set<AnnotationMirror> bottoms
```
    The bottom qualifiers of the type hierarchies. TODO: clarify relation to tops.
  - polyQualifiers
```
protected final Map<AnnotationMirror,AnnotationMirror> polyQualifiers
```
    See MultiGraphQualifierHierarchy.MultiGraphFactory.polyQualifiers.
    
    See Also:
    
    MultiGraphQualifierHierarchy.MultiGraphFactory.polyQualifiers
- Constructor Detail
  - MultiGraphQualifierHierarchy
```
public MultiGraphQualifierHierarchy(MultiGraphQualifierHierarchy.MultiGraphFactory f)
```
  - MultiGraphQualifierHierarchy
```
public MultiGraphQualifierHierarchy(MultiGraphQualifierHierarchy.MultiGraphFactory f,
                                    Object... args)
```
- Method Detail
  - isValid
```
public boolean isValid()
```
    Description copied from interface: QualifierHierarchy
    
    Determine whether this is valid.
    
    Specified by:
    
    isValid in interface QualifierHierarchy
    
    Returns:
    
    whether this is valid
  - finish
```
protected void finish(QualifierHierarchy qualHierarchy,
                      Map<AnnotationMirror,Set<AnnotationMirror>> supertypesTransitive,
                      Map<AnnotationMirror,AnnotationMirror> polyQualifiers,
                      Set<AnnotationMirror> tops,
                      Set<AnnotationMirror> bottoms,
                      Object... args)
```
    Method to finalize the qualifier hierarchy before it becomes unmodifiable. The parameters pass all fields and allow modification.
  - toString
```
@SideEffectFree
public String toString()
```
    Overrides:
    
    toString in class Object
  - 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 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
  - 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
    
    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
  - leastUpperBound
```
public 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 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
  - isSubtype
```
public boolean isSubtype(AnnotationMirror subAnno,
                         AnnotationMirror superAnno)
```
    Tests whether subQualifier is equal to or a sub-qualifier of superQualifier, according to the type qualifier hierarchy.
    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.
    
    Specified by:
    
    isSubtype in interface QualifierHierarchy
    
    Parameters:
    
    subAnno - the sub qualifier
    
    superAnno - the super qualifier
    
    Returns:
    
    true iff subQualifier is a subqualifier of, or equal to, superQualifier
  - findTops
```
protected Set<AnnotationMirror> findTops(Map<AnnotationMirror,Set<AnnotationMirror>> supertypes)
```
    Infer the tops of the subtype hierarchy. Simply finds the qualifiers that have no supertypes.
  - findBottoms
```
protected Set<AnnotationMirror> findBottoms(Map<AnnotationMirror,Set<AnnotationMirror>> supertypes)
```
    Infer the bottoms of the subtype hierarchy. Simple finds the qualifiers that are not supertypes of other qualifiers.
  - transitiveClosure
```
protected Map<AnnotationMirror,Set<AnnotationMirror>> transitiveClosure(Map<AnnotationMirror,Set<AnnotationMirror>> supertypes)
```
    Computes the transitive closure of the given map and returns it.
  - addPolyRelations
```
protected void addPolyRelations(QualifierHierarchy qualHierarchy,
                                Map<AnnotationMirror,Set<AnnotationMirror>> fullMap,
                                Map<AnnotationMirror,AnnotationMirror> polyQualifiers,
                                Set<AnnotationMirror> tops,
                                Set<AnnotationMirror> bottoms)
```
    Add the relationships for polymorphic qualifiers.
    A polymorphic qualifier, such as PolyNull, needs to be:
    1. a subtype of the top qualifier (e.g. Nullable)
    2. a supertype of all the bottom qualifiers (e.g. NonNull)
    Field supertypesTransitive is not set yet when this method is called -- use parameter fullMap instead.
  - findLub
```
protected AnnotationMirror findLub(AnnotationMirror a1,
                                   AnnotationMirror a2)
```
    Finds and returns the Least Upper Bound (LUB) of two annotation mirrors a1 and a2 by recursively climbing the qualifier hierarchy of a1 until one of them is a subtype of the other, or returns null if no subtype relationships can be found.
    
    Parameters:
    
    a1 - first annotation mirror
    
    a2 - second annotation mirror
    
    Returns:
    
    the LUB of a1 and a2, or null if none can be found
  - isPolymorphicQualifier
```
public boolean isPolymorphicQualifier(AnnotationMirror qual)
```
    Description copied from interface: QualifierHierarchy
    
    Returns true if the qualifier is a polymorphic qualifier; otherwise, returns false.
    
    Specified by:
    
    isPolymorphicQualifier in interface QualifierHierarchy
    
    Parameters:
    
    qual - qualifier
    
    Returns:
    
    true if the qualifier is a polymorphic qualifier; otherwise, returns false.

Class MultiGraphQualifierHierarchy

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

supertypesDirect

supertypesTransitive

tops

bottoms

polyQualifiers

Constructor Detail

MultiGraphQualifierHierarchy

MultiGraphQualifierHierarchy

Method Detail

isValid

finish

toString

getTopAnnotations

getTopAnnotation

getBottomAnnotations

getBottomAnnotation

getPolymorphicAnnotation

isSubtype

leastUpperBound

greatestLowerBound

isSubtype

findTops

findBottoms

transitiveClosure

addPolyRelations

findLub

isPolymorphicQualifier