org.checkerframework.framework.qual

Annotation Type RelevantJavaTypes

@Documented
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Inherited
public @interface RelevantJavaTypes

An annotation on a SourceChecker subclass to specify which Java types are processed by the checker. The checker's type qualifiers may only appear on the given types and their subtypes — in source code, internally in the compiler, or in class files.

If a checker is not annotated with this annotation, then the checker's qualifiers may appear on any type.

This is orthogonal to Java's @Target annotation; each enforces a different type of restriction on what can be written in source code.

See the Checker Framework Manual:

Relevant Java types

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.Class<?>[]	value Classes that are processed by the checker.

Element Detail

value

public abstract java.lang.Class<?>[] value

Classes that are processed by the checker.

Object[].class implies that the checker processes all array types. No distinction among array types is currently made, and no other array class should be supplied to @RelevantJavaTypes.

A boxed type, such as Integer.class, implies that the checker processes both the boxed type Integer and the unboxed primitive type int.