Checker Qual 3.38.0 · org.checkerframework.checker.i18nformatter.qual.I18nConversionCategory

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

@I18nFormat({GENERAL, NUMBER}) String f = "{0}{1, number}";
MessageFormat.format(f, "Example", 0) // valid

The annotation indicates that the format string requires any object as the first parameter (I18nConversionCategory#GENERAL) and a number as the second parameter (I18nConversionCategory#NUMBER).

Field Summary

Modifier and Type	Field and Description
private static final I18nConversionCategory[]	conversionCategoriesForIntersect Conversion categories that need to be considered by `intersect`.
public static final I18nConversionCategory	DATE Use if the parameter can be of date, time, or number types.
public static final I18nConversionCategory	GENERAL Use if the parameter can be of any type.
private static final I18nConversionCategory[]	namedCategories Used by `stringToI18nConversionCategory`.
public static final I18nConversionCategory	NUMBER Use if the parameter can be of number or choice types.
public final @Nullable []	strings
public final @Nullable Class<?>[]	types
public static final I18nConversionCategory	UNUSED Use if a parameter is not used by the formatter.

Constructor Summary

Access	Constructor and Description
private	I18nConversionCategory(@Nullable Class<?>[] types, @Nullable [] strings)

Method Summary

Modifier and Type	Method and Description
private static <E> Set<E>	arrayToSet(E[] a)
public static I18nConversionCategory	intersect(I18nConversionCategory a, I18nConversionCategory b) Returns the intersection of the two given I18nConversionCategories.
public boolean	Returns: true if `argType` can be an argument used by this format specifier isAssignableFrom(Class<?> an argument type argType) Returns true if `argType` can be an argument used by this format specifier.
public static boolean	Returns: true if a is a subset of b isSubsetOf(I18nConversionCategory a, I18nConversionCategory b) Return true if a is a subset of b.
public static I18nConversionCategory	Returns: the I18nConversionCategory associated with the given string stringToI18nConversionCategory(String string) Creates a conversion cagetogry from a string name.
public String	toString() Overrides java.lang.Enum.toString. Returns a pretty printed `I18nConversionCategory`.
public static I18nConversionCategory	union(I18nConversionCategory a, I18nConversionCategory b) Returns the union of the two given I18nConversionCategories.
public static I18nConversionCategory	valueOf(String name)
public static I18nConversionCategory[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal valueOf

Field Detail

conversionCategoriesForIntersect	back to summary
private static final I18nConversionCategory[] conversionCategoriesForIntersect Conversion categories that need to be considered by `intersect`.

DATE	back to summary
public static final I18nConversionCategory DATE Use if the parameter can be of date, time, or number types.

GENERAL	back to summary
public static final I18nConversionCategory GENERAL Use if the parameter can be of any type.

namedCategories	back to summary
private static final I18nConversionCategory[] namedCategories Used by `stringToI18nConversionCategory`.

NUMBER back to summary

NUMBER	back to summary
public static final I18nConversionCategory NUMBER Use if the parameter can be of number or choice types. An example of choice: `format("{0, choice, 0#zero\|1#one\|1<{0, number} is more than 1}", 2)` This will print "2 is more than 1".

public static final I18nConversionCategory NUMBER

Use if the parameter can be of number or choice types. An example of choice:

format("{0, choice, 0#zero|1#one|1<{0, number} is more than 1}", 2)

This will print "2 is more than 1".

strings	back to summary
public final @Nullable [] strings Annotations @SuppressWarnings:ImmutableEnumChecker

types	back to summary
public final @Nullable Class<?>[] types Annotations @SuppressWarnings:ImmutableEnumChecker

UNUSED	back to summary
public static final I18nConversionCategory UNUSED Use if a parameter is not used by the formatter. For example, in MessageFormat.format("{1}", a, b); only the second argument ("b") is used. The first argument ("a") is ignored.

UNUSED

back to summary

public static final I18nConversionCategory UNUSED

Use if a parameter is not used by the formatter. For example, in

MessageFormat.format("{1}", a, b);

only the second argument ("b") is used. The first argument ("a") is ignored.

Constructor Detail

I18nConversionCategory	back to summary
private I18nConversionCategory(@Nullable Class<?>[] types, @Nullable [] strings)

Method Detail

arrayToSet	back to summary
private static <E> Set<E> arrayToSet(E[] a)

intersect	back to summary
public static I18nConversionCategory intersect(I18nConversionCategory a, I18nConversionCategory b) Returns the intersection of the two given I18nConversionCategories. I18nConversionCategory.intersect(DATE, NUMBER) == NUMBER;

intersect

back to summary

public static I18nConversionCategory intersect(I18nConversionCategory a, I18nConversionCategory b)

Returns the intersection of the two given I18nConversionCategories.

I18nConversionCategory.intersect(DATE, NUMBER) == NUMBER;

isAssignableFrom back to summary

isAssignableFrom	back to summary
public boolean isAssignableFrom(Class<?> argType) Returns true if `argType` can be an argument used by this format specifier. Parameters argType:Class<?> an argument type Returns:boolean true if `argType` can be an argument used by this format specifier

public boolean isAssignableFrom(Class<?> argType)

Returns true if argType can be an argument used by this format specifier.

Parameters

argType:Class<?>: an argument type

Returns:boolean

true if argType can be an argument used by this format specifier

isSubsetOf	back to summary
public static boolean isSubsetOf(I18nConversionCategory a, I18nConversionCategory b) Return true if a is a subset of b. Returns:boolean true if a is a subset of b

isSubsetOf

back to summary

public static boolean isSubsetOf(I18nConversionCategory a, I18nConversionCategory b)

Return true if a is a subset of b.

Returns:boolean: true if a is a subset of b

stringToI18nConversionCategory	back to summary
public static I18nConversionCategory stringToI18nConversionCategory(String string) Creates a conversion cagetogry from a string name. I18nConversionCategory.stringToI18nConversionCategory("number") == I18nConversionCategory.NUMBER; Returns:I18nConversionCategory the I18nConversionCategory associated with the given string Annotations @SuppressWarnings:nullness:iterating.over.nullable

stringToI18nConversionCategory

back to summary

public static I18nConversionCategory stringToI18nConversionCategory(String string)

Creates a conversion cagetogry from a string name.

I18nConversionCategory.stringToI18nConversionCategory("number") == I18nConversionCategory.NUMBER;

Returns:I18nConversionCategory

the I18nConversionCategory associated with the given string

Annotations

@SuppressWarnings:nullness:iterating.over.nullable

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Enum.toString. Returns a pretty printed `I18nConversionCategory`. Returns:String Doc from java.lang.Enum.toString. the name of this enum constant Annotations @Override

public String toString()

Overrides java.lang.Enum.toString.

Returns a pretty printed I18nConversionCategory.

Returns:String

Doc from java.lang.Enum.toString.

the name of this enum constant

Annotations

@Override

union	back to summary
public static I18nConversionCategory union(I18nConversionCategory a, I18nConversionCategory b) Returns the union of the two given I18nConversionCategories. I18nConversionCategory.intersect(DATE, NUMBER) == DATE;

union

back to summary

public static I18nConversionCategory union(I18nConversionCategory a, I18nConversionCategory b)

Returns the union of the two given I18nConversionCategories.

I18nConversionCategory.intersect(DATE, NUMBER) == DATE;

valueOf	back to summary
public static I18nConversionCategory valueOf(String name)

values	back to summary
public static I18nConversionCategory[] values()

public final Enum I18nConversionCategory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail