framework.src.org.checkerframework.framework.qual.PreconditionAnnotation 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 java.lang.annotation.Annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * A meta-annotation that indicates that an annotation is a precondition
 * annotation, i.e., a type-specialized version of {@link RequiresQualifier}.
 * The annotation that is annotated as {@link PreconditionAnnotation} must have
 * a value called {@code value} that is an array of {@code String}s of the same
 * format and with the same meaning as the value {@code expression} in
 * {@link RequiresQualifier}.
 *
 * 
 * The value {@code qualifier} that is necessary for a precondition specified
 * with {@link RequiresQualifier} is hard-coded here with the value
 * {@code qualifier}.
 *
 * @author Stefan Heule
 * @see RequiresQualifier
 *
 */
@Target({ ElementType.ANNOTATION_TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface PreconditionAnnotation {
    /** The hard-coded qualifier for the precondition. */
    Class qualifier();
}