checker.src.org.checkerframework.checker.nullness.qual.PolyKeyFor Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of checker Show documentation

The Checker Framework enhances Java’s type system to make it more powerful and useful. This lets software developers detect and prevent errors in their Java programs. The Checker Framework includes compiler plug-ins ("checkers") that find bugs or verify their absence. It also permits you to write your own compiler plug-ins.

There is a newer version: 3.42.0

Show newest version

package org.checkerframework.checker.nullness.qual;

import org.checkerframework.framework.qual.PolymorphicQualifier;
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 polymorphic qualifier for the Map Key (@KeyFor) type system.
 *
 * 
 * Any method written using {@code @PolyKeyFor} conceptually has an
 * arbitrary number of versions:  one in which every instance of
 * {@code @PolyKeyFor} has been replaced by {@code @}{@link UnknownKeyFor},
 * one in which every instance of {@code @}{@link PolyKeyFor} has been
 * replaced by {@code @}{@link KeyForBottom}, and ones in which every
 * instance of {@code @PolyKeyFor} has been replaced by {@code @}{@code
 * KeyFor}, for every possible combination of map arguments.
 *
 * @checker_framework.manual #nullness-checker Nullness Checker
 */
@Documented
@PolymorphicQualifier(UnknownKeyFor.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE_USE, ElementType.TYPE_PARAMETER})
public @interface PolyKeyFor {}