org.checkerframework.checker.formatter.qual

Annotation Type FormatMethod

@Documented
 @Retention(value=RUNTIME)
 @Target(value={METHOD,CONSTRUCTOR})
public @interface FormatMethod

If this annotation is attached to a Formatter.format-like method, then the first, String parameter is treated as a format string for the remaining arguments. The Format String Checker ensures that the arguments passed as varargs are compatible with the format string argument, and also permits them to be passed to Formatter.format-like methods within the body.

The initial String parameter may optionally be preceded by a Locale parameter.

Author:

Konstantin Weitz

See the Checker Framework Manual:

Format String Checker