framework.src.org.checkerframework.framework.qual.DefaultQualifiers 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.framework.qual;

import static java.lang.annotation.ElementType.*;

import java.lang.annotation.*;

/**
 * Specifies the annotations to be included in a type without having to provide
 * them explicitly.
 * 
 *
 * This annotation permits specifying multiple default qualifiers for more
 * than one type system.  It is necessary because Java forbids multiple
 * annotations of the same name at a single location.
 *
 * Example:
 * 
 * 
 *   @DefaultQualifiers({
 *       @DefaultQualifier(NonNull.class),
 *       @DefaultQualifier(value = Interned.class, locations = ALL_EXCEPT_LOCALS),
 *       @DefaultQualifier(Tainted.class)
 *   })
 * 
 *
 * @see DefaultQualifier
 */
// TODO: use repeating annotations (will make source depend on Java 8).
@Documented
@Retention(RetentionPolicy.SOURCE)
@Target({PACKAGE, TYPE, CONSTRUCTOR, METHOD, FIELD, LOCAL_VARIABLE, PARAMETER})
public @interface DefaultQualifiers {
    /** The default qualifier settings */
    DefaultQualifier[] value() default { };
}