org.checkerframework.common.reflection.qual.ClassVal Maven / Gradle / Ivy

Go to download

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-eisop4

Show newest version

package org.checkerframework.common.reflection.qual;

import org.checkerframework.framework.qual.SubtypeOf;

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;

/**
 * This represents a {@link java.lang.Class Class<T>} object where the set of possible values
 * of T is known at compile time. If only one argument is given, then the exact value of T is known.
 * If more than one argument is given, then the value of T is one of those classes.
 *
 * @checker_framework.manual #methodval-and-classval-checkers ClassVal Checker
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE_USE, ElementType.TYPE_PARAMETER})
@SubtypeOf({UnknownClass.class})
public @interface ClassVal {
    /**
     * The name of the type that this Class object represents. The name is a "fully-qualified binary
     * name" ({@link org.checkerframework.checker.signature.qual.FqBinaryName}): a primitive or binary
     * name, possibly followed by some number of array brackets.
     *
     * @return the name of the type that this Class object represents
     */
    String[] value();
}