org.checkerframework.framework.type.poly

Class AbstractQualifierPolymorphism

java.lang.Object

org.checkerframework.framework.type.poly.AbstractQualifierPolymorphism

All Implemented Interfaces:

QualifierPolymorphism

Direct Known Subclasses:

DefaultQualifierPolymorphism

public abstract class AbstractQualifierPolymorphism
extends Object
implements QualifierPolymorphism

Implements framework support for qualifier polymorphism.

DefaultQualifierPolymorphism implements the abstract methods in this class. Subclasses can alter the way instantiations of polymorphic qualifiers are combined.

An "instantiation" is a mapping from declaration type to use-site type — that is, a mapping from @Poly* to concrete qualifiers.

The implementation performs these steps:

• the PolyCollector creates an instantiation
• if the instantiation is non-empty: the Replacer does resolution -- that is, it replaces each occurrence of @Poly* by the concrete qualifier it maps to in the instantiation
• if the instantiation is empty, the Completer replaces each @Poly* by the top qualifier

Field Summary

Fields

Modifier and Type	Field and Description
protected AnnotatedTypeFactory	atypeFactory Annotated type factory.
protected AnnotationMirror	POLYALL PolyAll annotation mirror.
protected AnnotationMirrorMap<AnnotationMirror>	polyQuals The polymorphic qualifiers: mapping from a polymorphic qualifier of qualHierarchy to the top qualifier of that hierarchy.
protected QualifierHierarchy	qualHierarchy The qualifier hierarchy to use.
protected AnnotationMirrorSet	topQuals The qualifiers at the top of qualHierarchy.

Constructor Summary

Constructors

Constructor and Description
AbstractQualifierPolymorphism(ProcessingEnvironment env, AnnotatedTypeFactory factory) Creates an AbstractQualifierPolymorphism instance that uses the given checker for querying type qualifiers and the given factory for getting annotated types.

Method Summary

Modifier and Type	Method and Description
protected abstract AnnotationMirrorSet	combine(AnnotationMirror polyQual, AnnotationMirrorSet a1Annos, AnnotationMirrorSet a2Annos) Returns an annotation set that is the merge of the two sets of annotations.
protected abstract void	replace(AnnotatedTypeMirror type, AnnotationMirrorMap<AnnotationMirrorSet> replacements) Replaces the top-level polymorphic annotations in type with the instantiations in replacements.
protected void	reset() Reset to allow reuse of the same instance.
void	resolve(AnnotatedTypeMirror.AnnotatedExecutableType functionalInterface, AnnotatedTypeMirror.AnnotatedExecutableType memberReference) Resolves polymorphism annotations for the given type.
void	resolve(MethodInvocationTree tree, AnnotatedTypeMirror.AnnotatedExecutableType type) Resolves polymorphism annotations for the given type.
void	resolve(NewClassTree tree, AnnotatedTypeMirror.AnnotatedExecutableType type) Resolves polymorphism annotations for the given type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.checkerframework.framework.type.poly.QualifierPolymorphism

getPolymorphicQualifier, getPolymorphicQualifierElement, getPolymorphicQualifierTop, hasPolymorphicQualifier, isPolyAll, isPolymorphicQualified

Field Detail

atypeFactory

protected final AnnotatedTypeFactory atypeFactory

Annotated type factory.

qualHierarchy

protected final QualifierHierarchy qualHierarchy

The qualifier hierarchy to use.

polyQuals

protected final AnnotationMirrorMap<AnnotationMirror> polyQuals

The polymorphic qualifiers: mapping from a polymorphic qualifier of qualHierarchy to the top qualifier of that hierarchy. The field is always non-null, but it might be an empty mapping. If a value is null, the polymorphic qualifier, such as PolyAll, applies to all hierarchies.

topQuals

protected final AnnotationMirrorSet topQuals

The qualifiers at the top of qualHierarchy. These are the values in polyQuals.

POLYALL

protected final AnnotationMirror POLYALL

PolyAll annotation mirror.

Constructor Detail

AbstractQualifierPolymorphism

public AbstractQualifierPolymorphism(ProcessingEnvironment env,
                                     AnnotatedTypeFactory factory)

Creates an AbstractQualifierPolymorphism instance that uses the given checker for querying type qualifiers and the given factory for getting annotated types. Subclasses need to add polymorphic qualifiers to this.polyQuals.

Parameters:

env - the processing environment

factory - the factory for the current checker

Method Detail

reset

protected void reset()

Reset to allow reuse of the same instance. Subclasses should override this method. The overriding implementation should clear its additional state and then call the super implementation.

resolve

public void resolve(MethodInvocationTree tree,
                    AnnotatedTypeMirror.AnnotatedExecutableType type)

Resolves polymorphism annotations for the given type.

Specified by:

resolve in interface QualifierPolymorphism

Parameters:

tree - the tree associated with the type

type - the type to annotate

resolve

public void resolve(NewClassTree tree,
                    AnnotatedTypeMirror.AnnotatedExecutableType type)

Description copied from interface: QualifierPolymorphism

Resolves polymorphism annotations for the given type.

Specified by:

resolve in interface QualifierPolymorphism

Parameters:

tree - the tree associated with the type

type - the type to annotate; is side-effected by this method

resolve

public void resolve(AnnotatedTypeMirror.AnnotatedExecutableType functionalInterface,
                    AnnotatedTypeMirror.AnnotatedExecutableType memberReference)

Description copied from interface: QualifierPolymorphism

Resolves polymorphism annotations for the given type.

Specified by:

resolve in interface QualifierPolymorphism

Parameters:

functionalInterface - the function type of memberReference

memberReference - the type of a member reference; is side-effected by this method

combine

protected abstract AnnotationMirrorSet combine(AnnotationMirror polyQual,
                                               AnnotationMirrorSet a1Annos,
                                               AnnotationMirrorSet a2Annos)

Returns an annotation set that is the merge of the two sets of annotations. The sets are instantiations for polyQual.

The combination is typically their least upper bound. (It could be the GLB in the case that all arguments to a polymorphic method must have the same annotation.)

Parameters:

polyQual - polymorphic qualifier for which a1Annos and a2Annos are instantiations

a1Annos - a set that is an instantiation of polyQual

a2Annos - a set that is an instantiation of polyQual

Returns:

the merge of the two sets

replace

protected abstract void replace(AnnotatedTypeMirror type,
                                AnnotationMirrorMap<AnnotationMirrorSet> replacements)

Replaces the top-level polymorphic annotations in type with the instantiations in replacements.

This method is called on all parts of a type.

Parameters:

type - AnnotatedTypeMirror whose poly annotations are replaced; it is side-effected by this method

replacements - mapping from polymorphic annotation to instantiation