org.checkerframework.framework.util

Class QualifierPolymorphism

java.lang.Object

org.checkerframework.framework.util.QualifierPolymorphism

public class QualifierPolymorphism
extends java.lang.Object

Implements framework support for type qualifier polymorphism. Checkers that wish to use it should add calls to annotate(MethodInvocationTree, AnnotatedTypeMirror.AnnotatedExecutableType) to the AnnotatedTypeFactory.addComputedTypeAnnotations(Tree, AnnotatedTypeMirror) and AnnotatedTypeFactory.addComputedTypeAnnotations(Tree, AnnotatedTypeMirror) methods.

This implementation currently only supports polymorphism for method invocations, for which the return type depends on the unification of the parameter/receiver types.

See Also:

PolymorphicQualifier

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<javax.lang.model.element.AnnotationMirror,javax.lang.model.element.AnnotationMirror>	polyQuals The polymorphic qualifiers: mapping from the top of a qualifier hierarchy to the polymorphic qualifier of that hierarchy.
protected QualifierHierarchy	qualhierarchy The qualifier hierarchy to use.
protected java.util.Set<? extends javax.lang.model.element.AnnotationMirror>	topQuals The qualifiers at the top of the qualifier hierarchy.

Constructor Summary

Constructors

Constructor and Description
QualifierPolymorphism(javax.annotation.processing.ProcessingEnvironment env, AnnotatedTypeFactory factory) Creates a QualifierPolymorphism 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
void	annotate(AnnotatedTypeMirror.AnnotatedExecutableType functionalInterface, AnnotatedTypeMirror.AnnotatedExecutableType memberReference)
void	annotate(com.sun.source.tree.MethodInvocationTree tree, AnnotatedTypeMirror.AnnotatedExecutableType type) Resolves polymorphism annotations for the given type.
void	annotate(com.sun.source.tree.NewClassTree tree, AnnotatedTypeMirror.AnnotatedExecutableType type)
static javax.lang.model.element.AnnotationMirror	getPolymorphicQualifier(javax.lang.model.element.AnnotationMirror qual)
static java.lang.Class<? extends java.lang.annotation.Annotation>	getPolymorphicQualifierTop(javax.lang.model.util.Elements elements, javax.lang.model.element.AnnotationMirror qual) Returns null if the qualifier is not polymorphic.
static boolean	isPolyAll(javax.lang.model.element.AnnotationMirror qual)
static boolean	isPolymorphicQualified(javax.lang.model.element.AnnotationMirror qual)

Methods inherited from class java.lang.Object

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

Field Detail

polyQuals

protected final java.util.Map<javax.lang.model.element.AnnotationMirror,javax.lang.model.element.AnnotationMirror> polyQuals

The polymorphic qualifiers: mapping from the top of a qualifier hierarchy to the polymorphic qualifier of that hierarchy. Field always non-null but might be an empty mapping. The "null" key, if present, always maps to PolyAll.

topQuals

protected final java.util.Set<? extends javax.lang.model.element.AnnotationMirror> topQuals

The qualifiers at the top of the qualifier hierarchy.

qualhierarchy

protected final QualifierHierarchy qualhierarchy

The qualifier hierarchy to use.

Constructor Detail

QualifierPolymorphism

public QualifierPolymorphism(javax.annotation.processing.ProcessingEnvironment env,
                             AnnotatedTypeFactory factory)

Creates a QualifierPolymorphism instance that uses the given checker for querying type qualifiers and the given factory for getting annotated types.

Parameters:

env - the processing environment

factory - the factory for the current checker

Method Detail

getPolymorphicQualifier

public static javax.lang.model.element.AnnotationMirror getPolymorphicQualifier(javax.lang.model.element.AnnotationMirror qual)

isPolymorphicQualified

public static boolean isPolymorphicQualified(javax.lang.model.element.AnnotationMirror qual)

isPolyAll

public static boolean isPolyAll(javax.lang.model.element.AnnotationMirror qual)

getPolymorphicQualifierTop

public static java.lang.Class<? extends java.lang.annotation.Annotation> getPolymorphicQualifierTop(javax.lang.model.util.Elements elements,
                                                                                                    javax.lang.model.element.AnnotationMirror qual)

Returns null if the qualifier is not polymorphic. Returns the (given) top of the type hierarchy, in which it is polymorphic, otherwise. The top qualifier is given by the programmer, so must be normalized to ensure its the real top.

annotate

public void annotate(com.sun.source.tree.MethodInvocationTree tree,
                     AnnotatedTypeMirror.AnnotatedExecutableType type)

Resolves polymorphism annotations for the given type.

Parameters:

tree - the tree associated with the type

type - the type to annotate

annotate

public void annotate(com.sun.source.tree.NewClassTree tree,
                     AnnotatedTypeMirror.AnnotatedExecutableType type)

annotate

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