org.checkerframework.framework.type.poly

Interface QualifierPolymorphism

All Known Implementing Classes:

AbstractQualifierPolymorphism, DefaultQualifierPolymorphism

public interface QualifierPolymorphism

Interface to implement qualifier polymorphism.

See Also:

PolymorphicQualifier, AbstractQualifierPolymorphism, DefaultQualifierPolymorphism

Method Summary

Modifier and Type	Method and Description
void	annotate(AnnotatedTypeMirror.AnnotatedExecutableType functionalInterface, AnnotatedTypeMirror.AnnotatedExecutableType memberReference) Resolves polymorphism annotations for the given type.
void	annotate(MethodInvocationTree tree, AnnotatedTypeMirror.AnnotatedExecutableType type) Resolves polymorphism annotations for the given type.
void	annotate(NewClassTree tree, AnnotatedTypeMirror.AnnotatedExecutableType type) Resolves polymorphism annotations for the given type.
static AnnotationMirror	getPolymorphicQualifier(AnnotationMirror qual)
static Name	getPolymorphicQualifierElement(AnnotationMirror qual) If qual is a polymorphic qualifier, return the class specified by the PolymorphicQualifier meta-annotation on the polymorphic qualifier is returned.
static Name	getPolymorphicQualifierTop(AnnotationMirror qual) Deprecated. use getPolymorphicQualifierElement
static boolean	hasPolymorphicQualifier(AnnotationMirror qual)
static boolean	isPolyAll(AnnotationMirror qual)
static boolean	isPolymorphicQualified(AnnotationMirror qual) Deprecated. use hasPolymorphicQualifier(javax.lang.model.element.AnnotationMirror)

Method Detail

isPolyAll

static boolean isPolyAll(AnnotationMirror qual)

Returns:

true if qual is @PolyAll

getPolymorphicQualifier

static AnnotationMirror getPolymorphicQualifier(AnnotationMirror qual)

Returns:

the PolymorphicQualifier meta-annotation on qual if one exists; otherwise return null

isPolymorphicQualified

@Deprecated
static boolean isPolymorphicQualified(AnnotationMirror qual)

Deprecated. use hasPolymorphicQualifier(javax.lang.model.element.AnnotationMirror)

Returns:

true if qual has the PolymorphicQualifier meta-annotation

hasPolymorphicQualifier

static boolean hasPolymorphicQualifier(AnnotationMirror qual)

Returns:

true if qual has the PolymorphicQualifier meta-annotation.

getPolymorphicQualifierTop

@Deprecated
static Name getPolymorphicQualifierTop(AnnotationMirror qual)

Deprecated. use getPolymorphicQualifierElement

If qual is a polymorphic qualifier, return the class specified by the PolymorphicQualifier meta-annotation on the polymorphic qualifier is returned. Otherwise, return null.

This value identifies the qualifier hierarchy to which this polymorphic qualifier belongs. By convention, it is the top qualifier of the hierarchy. Use of PolymorphicQualifier.class is discouraged, because it can lead to ambiguity if used for multiple type systems.

Parameters:

qual - an annotation

Returns:

the class specified by the PolymorphicQualifier meta-annotation on qual, if qual is a polymorphic qualifier; otherwise, null.

See Also:

PolymorphicQualifier.value()

getPolymorphicQualifierElement

static Name getPolymorphicQualifierElement(AnnotationMirror qual)

If qual is a polymorphic qualifier, return the class specified by the PolymorphicQualifier meta-annotation on the polymorphic qualifier is returned. Otherwise, return null.

This value identifies the qualifier hierarchy to which this polymorphic qualifier belongs. By convention, it is the top qualifier of the hierarchy. Use of PolymorphicQualifier.class is discouraged, because it can lead to ambiguity if used for multiple type systems.

Parameters:

qual - an annotation

Returns:

the class specified by the PolymorphicQualifier meta-annotation on qual, if qual is a polymorphic qualifier; otherwise, null.

See Also:

PolymorphicQualifier.value()

annotate

void annotate(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; is side-effected by this method

annotate

void annotate(NewClassTree tree,
              AnnotatedTypeMirror.AnnotatedExecutableType type)

Resolves polymorphism annotations for the given type.

Parameters:

tree - the tree associated with the type

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

annotate

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

Resolves polymorphism annotations for the given type.

Parameters:

functionalInterface - the function type of memberReference

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