org.checkerframework.framework.qual.UpperBoundFor Maven / Gradle / Ivy
package org.checkerframework.framework.qual;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* A meta-annotation applied to the declaration of a type qualifier specifies that the given
* annotation should be upper bound for.
*
*
* - a use of a particular type.
*
- a use of a particular kind of type.
*
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface UpperBoundFor {
/** @return {@link TypeKind}s of types for which an annotation should be added by default */
TypeKind[] typeKinds() default {};
/**
* @return {@link Class}es for which an annotation should be applied. For example, if
* {@code @MyAnno} is meta-annotated with {@code @DefaultFor(classes=String.class)}, then
* every occurrence of {@code String} is actually {@code @MyAnno String}.
*/
Class[] types() default {};
}