org.checkerframework.framework.qual

Annotation Type ImplicitFor

@Retention(value=RUNTIME)
 @Target(value=ANNOTATION_TYPE)
public @interface ImplicitFor

A meta-annotation that specifies the trees and types for which the framework should automatically add that qualifier. These types and trees can be specified via a combination of attributes.

For example, the Nullable annotation is annotated with

   @ImplicitFor(literals = LiteralKind.NULL)
 

to denote that the literal null always has the type qualifier @Nullable.

See the Checker Framework Manual:

Declaratively specifying implicit annotations

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
LiteralKind[]	literals
String[]	stringPatterns
Class<?>[]	typeNames
TypeKind[]	types

Element Detail

literals

public abstract LiteralKind[] literals

Returns:

LiteralKinds for which an annotation should be implicitly added. For example, if @MyAnno is meta-annotated with @ImplicitFor(literals={LiteralKind.STRING}), then a literal String constant such as "hello world" has type @MyAnno String, but other occurrences of String in the source code are not affected. For String literals, also see the stringPatterns() annotation field.

Default:

{}

types

public abstract TypeKind[] types

Returns:

TypeKinds of types for which an annotation should be implicitly added

Default:

{}

typeNames

public abstract Class<?>[] typeNames

Returns:

Classes (in the actual program) for which an annotation should be implicitly added. For example, if @MyAnno is meta-annotated with @ImplicitFor(typeNames=String.class), then every occurrence of String is actually @MyAnno String. This has the same effect as writing the annotation on the class definition (possibly in an annotated library):

   class @MyAnno String {...}
 

As another example, {code java.lang.Void.class} should receive the same annotation as the null literal.

Default:

{}

stringPatterns

public abstract String[] stringPatterns

Returns:

regular expressions of string literals, the types of which an annotation should be implicitly added. If multiple patterns match, then the string literal is given the greatest lower bound of all the matches.

Default:

{}