org.checkerframework.framework.source.SupportedLintOptions 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.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;
// TODO: Are superclasses considered? Should we?
/**
* An annotation used to indicate what lint options a checker supports. For example, if a checker
* class (one that extends BaseTypeChecker) is annotated with
* {@code @SupportedLintOptions({"dotequals"})}, then the checker accepts the command-line option
* {@code -Alint=-dotequals}.
*
* This annotation is optional and many checkers do not contain an {@code @SupportedLintOptions}
* annotation.
*
*
The {@link SourceChecker#getSupportedLintOptions} method can construct its result from the
* value of this annotation.
*
* @see org.checkerframework.framework.source.SupportedOptions
* @checker_framework.manual #creating-compiler-interface The checker class: Compiler interface
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Inherited
public @interface SupportedLintOptions {
String[] value();
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy