Package org.checkerframework.framework.qual

Annotation Interface QualifierForLiterals

@Documented @Retention(RUNTIME) @Target(ANNOTATION_TYPE) public @interface QualifierForLiterals
A meta-annotation that indicates what qualifier should be given to literals. @QualifierForLiterals (without any annotation elements) is equivalent to @QualifierForLiterals(LiteralKind.ALL)

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    stringPatterns
    A string literal that matches any of these patterns has this qualifier.
    LiteralKind[]
    value
    The kinds of literals whose types have this qualifier.

  • Element Details

    • value

      LiteralKind[] value
      The kinds of literals whose types have this qualifier. For example, if @MyAnno is meta-annotated with @QualifierForLiterals(LiteralKind.STRING), then a literal String constant such as "hello world" has type @MyAnno String, but occurrences of String in the source code are not affected.

      For String literals, also see the stringPatterns() annotation element/field.

      Default:
      {}

    • stringPatterns

      String[] stringPatterns
      A string literal that matches any of these patterns has this qualifier.

      If patterns for multiple qualifiers match, then the string literal is given the greatest lower bound of all the matches.

      Default:
      {}