framework.src.org.checkerframework.framework.qual.IgnoreInWholeProgramInference Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of checker Show documentation
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.
package org.checkerframework.framework.qual;
import java.lang.annotation.*;
/**
* A meta-annotation indicating that an annotation type prevents whole-program
* inference. For example, if the definition of @Inject
is
* meta-annotated with @IgnoreInWholeProgramInference
:
* @IgnoreInWholeProgramInference
* @interface Inject { }
* then no type qualifier will be inferred for any field annotated by
* @Inject
.
*
*
* This is appropriate for fields that are set reflectively, so there are
* no calls in client code that type inference can learn from.
* Examples of qualifiers that should be meta-annotated with
* @IgnoreInWholeProgramInference
include
* @Inject
,
* @Singleton
,
* and
* @Option
.
*
*
* See {@link org.checkerframework.common.wholeprograminference.WholeProgramInferenceScenes#updateInferredFieldType}
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface IgnoreInWholeProgramInference { }