package org.checkerframework.checker.i18nformatter.qual;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.checkerframework.checker.i18nformatter.I18nFormatUtil;
/**
* This annotation is used internally to annotate {@link I18nFormatUtil#hasFormat} (and will
* potentially be used to annotate more such functions in the future).
*
* <p>Attach this annotation to a method with the following properties:
*
* <ul>
* <li>The first parameter is a format string.
* <li>The second parameter is a vararg that takes conversion categories.
* <li>The method returns true if the format string is compatible with the conversion categories.
* </ul>
*
* @checker_framework.manual #i18n-formatter-checker Internationalization Format String Checker
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface I18nChecksFormat {}