checkers.quals

Annotation Type DefaultQualifier

@Documented
 @Retention(value=RUNTIME)
 @Target(value={CONSTRUCTOR,METHOD,FIELD,LOCAL_VARIABLE,PARAMETER,TYPE})
public @interface DefaultQualifier

Applied to a declaration of a package, type, method, variable, etc., specifies that the given annotation should be the default. The default is applied to all types within the declaration for which no other annotation is explicitly written. If multiple DefaultQualifier annotations are in scope, the innermost one takes precedence. DefaultQualifier takes precedence over DefaultQualifierInHierarchy.

If you wish to write multiple @DefaultQualifier annotations (for unrelated type systems, or with different locations fields) at the same location, use DefaultQualifiers.

See Also:

DefaultLocation

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	value The name of the default annotation.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
DefaultLocation[]	locations

Element Detail

value

public abstract java.lang.String value

The name of the default annotation. It may be a short name like "NonNull", if an appropriate import statement exists. Otherwise, it should be fully-qualified, like "checkers.nullness.quals.NonNull".

To prevent affecting other type systems, always specify an annotation in your own type hierarchy. (For example, do not set "checkers.quals.Unqualified" as the default.)

Returns:

the name of the default annotation

locations

public abstract DefaultLocation[] locations

Returns:

the locations to which the annotation should be applied

Default:

checkers.quals.DefaultLocation.ALL