org.checkerframework.framework.util

Class MultiGraphQualifierHierarchy.MultiGraphFactory

java.lang.Object

org.checkerframework.framework.util.MultiGraphQualifierHierarchy.MultiGraphFactory

Enclosing class:

MultiGraphQualifierHierarchy

public static class MultiGraphQualifierHierarchy.MultiGraphFactory
extends 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 AnnotatedTypeFactory	atypeFactory The annotated type factory associated with this hierarchy.
protected Map<AnnotationMirror,AnnotationMirror>	polyQualifiers Map from qualifier hierarchy to the corresponding polymorphic qualifier.
protected Map<AnnotationMirror,Set<AnnotationMirror>>	supertypesDirect Map from qualifiers to the direct supertypes of the qualifier.

Constructor Summary

Constructors

Constructor and Description
MultiGraphFactory(AnnotatedTypeFactory atypeFactory) Create a factory.

Method Summary

Modifier and Type	Method and Description
void	addQualifier(AnnotationMirror qual) Adds the passed qualifier to the hierarchy.
void	addSubtype(AnnotationMirror sub, AnnotationMirror sup) Adds a subtype relationship between the two type qualifiers.
protected void	assertNotBuilt() Throw an exception if the factory was already built.
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

supertypesDirect

protected final Map<AnnotationMirror,Set<AnnotationMirror>> supertypesDirect

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<AnnotationMirror,AnnotationMirror> polyQualifiers

Map from qualifier hierarchy to the corresponding polymorphic qualifier. The key is:

• the argument to @PolymorphicQualifier (typically the top qualifier in the hierarchy), or
• "PolymorphicQualifier" if @PolymorphicQualifier is used without an argument, or

atypeFactory

protected final AnnotatedTypeFactory atypeFactory

The annotated type factory associated with this hierarchy.

Constructor Detail

MultiGraphFactory

public MultiGraphFactory(AnnotatedTypeFactory atypeFactory)

Create a factory.

Method Detail

addQualifier

public void addQualifier(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(AnnotationMirror sub,
                       AnnotationMirror sup)

Adds a subtype relationship between the two type qualifiers. Assumes that both qualifiers are part of the same qualifier hierarchy; callers should ensure this.

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()

Throw an exception if the factory was already built.