org.checkerframework.framework.source

Annotation Type SuppressWarningsKeys

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

Specifies the argument(s) that this checker recognizes for suppressing warnings via the SuppressWarnings annotation. Any of the given arguments suppresses all warnings related to the checker.

In order for this annotation to have an effect, it must be placed on the declaration of a class that extends SourceChecker.

For example, warnings issued by the Nullness Checker can be suppressed using @SuppressWarnings("nullness") because NullnessChecker is annotated with @SuppressWarningsKey("nullness").

TODO: the previous paragraph about the Nullness Checker is out-of-date. We only consider this meta-annotation on the most-concrete SourceChecker subclass and only use the suppression keys listed there. For the Nullness Checker we add multiple suppression keys along the hierarchy. Should we change the semantics of this annotation to look for it on all classes from the most-concrete class up to SourceChecker? That would make the behavior consistent with e.g. our SupportedOptions. Is there ever a reason where that would be unwanted?

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String[]	value

Element Detail

value

public abstract String[] value

Returns:

array of strings, any one of which causes this checker to suppress a warning when passed as the argument of @SuppressWarnings