org.checkerframework.framework.qual.StubFiles 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.44.0

Show newest version

package org.checkerframework.framework.qual;

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;

/**
 * An annotation on a SourceChecker subclass to provide additional stub files that should be used in
 * addition to {@code jdk.astub}. This allows larger compound checkers to separate the annotations
 * into multiple files, or to provide annotations for non-JDK classes.
 *
 * This annotation is not inherited. That means that if a checker with this annotation is
 * subclassed, then this annotation must be copied to the subclass and the stub file must also be
 * copied to the directory that contains the subclass.
 *
 * @checker_framework.manual #creating-a-checker-annotated-jdk Annotated JDK
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface StubFiles {
  /**
   * Stub file names. These are basenames: they include the extension (usually ".astub"), but no
   * directory component.
   */
  String[] value();
}