org.checkerframework.framework.source.SupportedOptions Maven / Gradle / Ivy

Go to download

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-eisop4

Show newest version

package org.checkerframework.framework.source;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * An annotation used to indicate what Checker Framework options a checker supports. The {@link
 * SourceChecker#getSupportedOptions} method constructs its result from the value of this annotation
 * and additionally prefixing the checker class name.
 *
 * In contrast to {@link javax.annotation.processing.SupportedOptions}, note that this qualifier
 * is {@link Inherited}.
 *
 * @see SupportedLintOptions
 * @see javax.annotation.processing.SupportedOptions
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Inherited
public @interface SupportedOptions {
    String[] value();
}