checkers.util

Class MultiGraphQualifierHierarchy.MultiGraphFactory

@NonNull java.lang.Object

checkers.util.MultiGraphQualifierHierarchy.MultiGraphFactory

Enclosing class:

MultiGraphQualifierHierarchy

public static class MultiGraphQualifierHierarchy.MultiGraphFactory
extends @NonNull Object

Factory used to create an instance of GraphQualifierHierarchy. A factory can be used to create at most one GraphQualifierHierarchy. To create a hierarchy, a client may do so in three steps: 1. add qualifiers using addQualifier(AnnotationMirror); 2. add subtype relations using addSubtype(AnnotationMirror, AnnotationMirror) 3. build the hierarchy and gets using build(). Notice that addSubtype(AnnotationMirror, AnnotationMirror) adds the two qualifiers to the hierarchy if they are not already in. Also, once the client builds a hierarchy through build(), no further modifications are allowed nor can it making a new instance. Clients build the hierarchy using addQualifier(AnnotationMirror) and addSubtype(AnnotationMirror, AnnotationMirror), then get the instance with calling build()

Field Summary

Fields

Modifier and Type	Field and Description
protected AnnotationUtils	annoFactory
protected BaseTypeChecker	checker
protected Map<@Nullable AnnotationMirror,@Nullable AnnotationMirror>	polyQualifiers Map from qualifier hierarchy to the corresponding polymorphic qualifier.
protected Map<@Nullable AnnotationMirror,Set<@Nullable AnnotationMirror>>	supertypes Map from qualifiers to the direct supertypes of the qualifier.

Constructor Summary

Constructors

Constructor and Description
MultiGraphQualifierHierarchy.MultiGraphFactory(BaseTypeChecker checker)

Method Summary

Methods

Modifier and Type	Method and Description
void	addQualifier(@Nullable AnnotationMirror qual) Adds the passed qualifier to the hierarchy.
void	addSubtype(@Nullable AnnotationMirror sub, @Nullable AnnotationMirror sup) Adds a subtype relationship between the two type qualifiers.
protected void	assertNotBuilt()
QualifierHierarchy	build() Returns an instance of GraphQualifierHierarchy that represents the hierarchy built so far
protected QualifierHierarchy	createQualifierHierarchy()

Methods inherited from class java.lang.Object

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

Field Detail

supertypes

protected final Map<@Nullable AnnotationMirror,Set<@Nullable AnnotationMirror>> supertypes

Map from qualifiers to the direct supertypes of the qualifier. Only the subtype relations given by addSubtype are in this mapping, no transitive relationships. It is immutable once GraphQualifierHierarchy is built. No polymorphic qualifiers are contained in this map.

polyQualifiers

protected final Map<@Nullable AnnotationMirror,@Nullable AnnotationMirror> polyQualifiers

Map from qualifier hierarchy to the corresponding polymorphic qualifier. The key is the declared qualifier given in @PolymorphicQualifier. Note that the non-type-qualifier key "PolymorphicQualifier" is used for a type system with a single hierarchy that gives no explicit top. Key "null" is used for the PolyAll qualifier.

checker

protected final BaseTypeChecker checker

annoFactory

protected final AnnotationUtils annoFactory

Constructor Detail

MultiGraphQualifierHierarchy.MultiGraphFactory

public MultiGraphQualifierHierarchy.MultiGraphFactory(BaseTypeChecker checker)

Method Detail

addQualifier

public void addQualifier(@Nullable AnnotationMirror qual)

Adds the passed qualifier to the hierarchy. Clients need to specify its super qualifiers in subsequent calls to addSubtype(AnnotationMirror, AnnotationMirror).

addSubtype

public void addSubtype(@Nullable AnnotationMirror sub,
              @Nullable AnnotationMirror sup)

Adds a subtype relationship between the two type qualifiers.

Parameters:

sub - the sub type qualifier

sup - the super type qualifier

build

public QualifierHierarchy build()

Returns an instance of GraphQualifierHierarchy that represents the hierarchy built so far

createQualifierHierarchy

protected QualifierHierarchy createQualifierHierarchy()

assertNotBuilt

protected void assertNotBuilt()