Top Description Methods
org.checkerframework.framework.qual

public @Interface PolymorphicQualifier

extends Annotation
Annotations
@Documented
@Retention:RUNTIME
@Target:ANNOTATION_TYPE
@AnnotatedFor:nullness
Imports
java.lang.annotation.Annotation, .Documented, .ElementType, .Retention, .RetentionPolicy, .Target

A meta-annotation that indicates that an annotation is a polymorphic type qualifier.

Any method written using a polymorphic type qualifier conceptually has two or more versions — one version for each qualifier in the qualifier hierarchy. In each version of the method, all instances of the polymorphic type qualifier are replaced by one of the other type qualifiers.

Method Summary

Modifier and TypeMethod and Description
public Class<? extends Annotation>

Returns:

the top qualifier in the hierarchy of this qualifier
value
()

Indicates which type system this annotation refers to (optional, and usually unnecessary).

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

valueback to summary
public Class<? extends Annotation> value()

Indicates which type system this annotation refers to (optional, and usually unnecessary). When multiple type hierarchies are supported by a single type system, then each polymorphic qualifier needs to indicate which sub-hierarchy it belongs to. Do so by passing the top qualifier from the given hierarchy.

Returns:Class<? extends Annotation>

the top qualifier in the hierarchy of this qualifier