Top Annotations Enums
[default module]

Package org.checkerframework.checker.formatter.qual


Annotation Summary

Modifier and TypeAnnotation and Description
public @interface
Format

This annotation, attached to a String type, indicates that the String may be passed to Formatter.format and similar methods.

public @interface
FormatBottom

The bottom type in the Format String type system.

public @interface
FormatMethod

If this annotation is attached to a Formatter.format-like method, then the first parameter of type String is treated as a format string for the following arguments.

public @interface
InvalidFormat

This annotation, attached to a String type, indicates that the string is not a legal format string.

public @interface
ReturnsFormat

Attach this annotation to a method with the following properties:

  • The first parameter is a format string.
  • The second parameter is a vararg that takes conversion categories.
  • The method throws an exception if the format string's format specifiers do not match the passed conversion categories.
  • On success, the method returns the passed format string unmodified.
public @interface
UnknownFormat

The top qualifier.

Enum Summary

Modifier and TypeEnum and Description
public enum
ConversionCategory

Elements of this enumeration are used in a Format annotation to indicate the valid types that may be passed as a format parameter.