checkers.quals.DefaultQualifiers Maven / Gradle / Ivy

Go to download
package checkers.quals;

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.RUNTIME)
@Target({PACKAGE, TYPE, CONSTRUCTOR, METHOD, FIELD, LOCAL_VARIABLE, PARAMETER})
public @interface DefaultQualifiers {
    /** The default qualifier settings */
    DefaultQualifier[] value() default { };
}