Package checkers.quals

Annotation Interface DefaultQualifier

@Documented @Retention(RUNTIME) @Target({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:

  • Required Element Summary

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

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    DefaultLocation[]
    locations
     

  • Element Details

    • value

      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

      DefaultLocation[] locations
      Returns:
      the locations to which the annotation should be applied
      Default:
      {ALL}