Checker Qual 3.38.0 · org.checkerframework.checker.formatter.qual.ConversionCategory

Field Summary

Modifier and Type	Field and Description
public static final ConversionCategory	CHAR Use if the parameter is of a basic types which represent Unicode characters: char, Character, byte, Byte, short, and Short.
public static final ConversionCategory	CHAR_AND_INT Use if the parameter is both a char and an int.
public final @Nullable String	chars The format specifier characters.
private static final ConversionCategory[]	conversionCategoriesForIntersect Conversion categories that need to be considered by `intersect`.
private static final ConversionCategory[]	conversionCategoriesForUnion Conversion categories that need to be considered by `union`.
private static final ConversionCategory[]	conversionCategoriesWithChar The conversion categories that have a corresponding conversion character.
public static final ConversionCategory	FLOAT Use if the parameter is a floating-point type: float, Float, double, Double, and BigDecimal.
public static final ConversionCategory	GENERAL Use if the parameter can be of any type.
public static final ConversionCategory	INT Use if the parameter is an integral type: byte, Byte, short, Short, int and Integer, long, Long, and BigInteger.
public static final ConversionCategory	INT_AND_TIME Use if the parameter is both an int and a time.
public static final ConversionCategory	NULL Use if no object of any type can be passed as parameter.
public static final ConversionCategory	TIME Use if the parameter is a type which is capable of encoding a date or time: long, Long, Calendar, and Date.
public final @Nullable Class<?>[]	types The argument types.
public static final ConversionCategory	UNUSED Use if a parameter is not used by the formatter.

Constructor Summary

Access	Constructor and Description
private	ConversionCategory(@Nullable String the format specifier characters. Null means users cannot specify it directly. chars, @Nullable Class<?>... the argument types. Null means every type. types) Create a new conversion category.

Method Summary

Modifier and Type	Method and Description
private static <E> Set<E>	arrayToSet(E[] a)
public static ConversionCategory	Returns: the category for the given conversion character fromConversionChar(char a conversion character c) Converts a conversion character to a category.
public static ConversionCategory	Returns: the intersection of the two categories (their greatest lower bound) intersect(ConversionCategory a category a, ConversionCategory a category b) Returns the intersection of two categories.
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	isSubsetOf(ConversionCategory a, ConversionCategory b)
public String	toString() Overrides java.lang.Enum.toString. Returns a pretty printed `ConversionCategory`.
public static ConversionCategory	Returns: the union of the two categories (their least upper bound) union(ConversionCategory a category a, ConversionCategory a category b) Returns the union of two categories.
private static @Nullable Class<? extends Object>	Returns: the unwrapped primitive, or null unwrapPrimitive(Class<?> a class c) If the given class is a primitive wrapper, return the corresponding primitive class.
public static ConversionCategory	valueOf(String name)
public static ConversionCategory[]	values()

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

Field Detail

CHAR	back to summary
public static final ConversionCategory CHAR Use if the parameter is of a basic types which represent Unicode characters: char, Character, byte, Byte, short, and Short. This conversion may also be applied to the types int and Integer when Character.isValidCodePoint(int) returns true. Applicable for conversions c, C.

CHAR_AND_INT	back to summary
public static final ConversionCategory CHAR_AND_INT Use if the parameter is both a char and an int. In a format string, multiple conversions may be applied to the same parameter. This is seldom needed, but the following is an example of such use: format("Test %1$c %1$d", (int)42); In this example, the first parameter is interpreted as both a character and an int, therefore the parameter must be compatible with both conversion, and can therefore neither be char nor long. This intersection of conversions is called CHAR_AND_INT. One other conversion intersection is interesting, namely the intersection of INT and TIME, resulting in INT_AND_TIME. All other intersection either lead to an already existing type, or NULL, in which case it is illegal to pass object's of any type as parameter.

CHAR_AND_INT

back to summary

public static final ConversionCategory CHAR_AND_INT

Use if the parameter is both a char and an int.

In a format string, multiple conversions may be applied to the same parameter. This is seldom needed, but the following is an example of such use:

  format("Test %1$c %1$d", (int)42);

In this example, the first parameter is interpreted as both a character and an int, therefore the parameter must be compatible with both conversion, and can therefore neither be char nor long. This intersection of conversions is called CHAR_AND_INT.

One other conversion intersection is interesting, namely the intersection of INT and TIME, resulting in INT_AND_TIME.

All other intersection either lead to an already existing type, or NULL, in which case it is illegal to pass object's of any type as parameter.

chars	back to summary
public final @Nullable String chars The format specifier characters. Null means users cannot specify it directly.

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

conversionCategoriesForUnion	back to summary
private static final ConversionCategory[] conversionCategoriesForUnion Conversion categories that need to be considered by `union`.

conversionCategoriesWithChar	back to summary
private static final ConversionCategory[] conversionCategoriesWithChar The conversion categories that have a corresponding conversion character. This lacks UNUSED, TIME_AND_INT, etc.

FLOAT	back to summary
public static final ConversionCategory FLOAT Use if the parameter is a floating-point type: float, Float, double, Double, and BigDecimal. Applicable for conversions e, E, f, g, G, a, A.

GENERAL	back to summary
public static final ConversionCategory GENERAL Use if the parameter can be of any type. Applicable for conversions b, B, h, H, s, S.

INT	back to summary
public static final ConversionCategory INT Use if the parameter is an integral type: byte, Byte, short, Short, int and Integer, long, Long, and BigInteger. Applicable for conversions d, o, x, X.

INT_AND_TIME back to summary

INT_AND_TIME	back to summary
public static final ConversionCategory INT_AND_TIME Use if the parameter is both an int and a time. See Also `CHAR_AND_INT`

public static final ConversionCategory INT_AND_TIME

Use if the parameter is both an int and a time.

See Also: CHAR_AND_INT

NULL	back to summary
public static final ConversionCategory NULL Use if no object of any type can be passed as parameter. In this case, the only legal value is null. This is seldomly needed, and indicates an error in most cases. For example: format("Test %1$f %1$d", null); Only null can be legally passed, passing a value such as 4 or 4.2 would lead to an exception.

NULL

back to summary

public static final ConversionCategory NULL

Use if no object of any type can be passed as parameter. In this case, the only legal value is null. This is seldomly needed, and indicates an error in most cases. For example:

  format("Test %1$f %1$d", null);

Only null can be legally passed, passing a value such as 4 or 4.2 would lead to an exception.

TIME	back to summary
public static final ConversionCategory TIME Use if the parameter is a type which is capable of encoding a date or time: long, Long, Calendar, and Date. Applicable for conversions t, T. Annotations @SuppressWarnings:JdkObsolete

types	back to summary
public final @Nullable Class<?>[] types The argument types. Null means every type. Annotations @SuppressWarnings:ImmutableEnumChecker

UNUSED	back to summary
public static final ConversionCategory UNUSED Use if a parameter is not used by the formatter. This is seldomly needed, and indicates an error in most cases. For example: format("Test %1$s %3$s", "a","unused","b"); Only the first "a" and third "b" parameters are used, the second "unused" parameter is ignored.

UNUSED

back to summary

public static final ConversionCategory UNUSED

Use if a parameter is not used by the formatter. This is seldomly needed, and indicates an error in most cases. For example:

  format("Test %1$s %3$s", "a","unused","b");

Only the first "a" and third "b" parameters are used, the second "unused" parameter is ignored.

Constructor Detail

ConversionCategory	back to summary
private ConversionCategory(@Nullable String chars, @Nullable Class<?>... types) Create a new conversion category. Parameters chars:@Nullable String the format specifier characters. Null means users cannot specify it directly. types:@Nullable Class<?>[] the argument types. Null means every type.

ConversionCategory

back to summary

private ConversionCategory(@Nullable String chars, @Nullable Class<?>... types)

Create a new conversion category.

Parameters

chars:@Nullable String: the format specifier characters. Null means users cannot specify it directly.
types:@Nullable Class<?>[]: the argument types. Null means every type.

Method Detail

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

fromConversionChar back to summary

fromConversionChar	back to summary
public static ConversionCategory fromConversionChar(char c) Converts a conversion character to a category. For example: `ConversionCategory.fromConversionChar('d') == ConversionCategory.INT` Parameters c:char a conversion character Returns:ConversionCategory the category for the given conversion character Annotations @SuppressWarnings:nullness:dereference.of.nullable

public static ConversionCategory fromConversionChar(char c)

Converts a conversion character to a category. For example:

ConversionCategory.fromConversionChar('d') == ConversionCategory.INT

Parameters

c:char: a conversion character

Returns:ConversionCategory

the category for the given conversion character

Annotations

@SuppressWarnings:nullness:dereference.of.nullable

intersect	back to summary
public static ConversionCategory intersect(ConversionCategory a, ConversionCategory b) Returns the intersection of two categories. This is seldomly needed. ConversionCategory.intersect(INT, TIME) == INT_AND_TIME; Parameters a:ConversionCategory a category b:ConversionCategory a category Returns:ConversionCategory the intersection of the two categories (their greatest lower bound)

intersect

back to summary

public static ConversionCategory intersect(ConversionCategory a, ConversionCategory b)

Returns the intersection of two categories. This is seldomly needed.

ConversionCategory.intersect(INT, TIME) == INT_AND_TIME;

Parameters

a:ConversionCategory: a category
b:ConversionCategory: a category

Returns:ConversionCategory

the intersection of the two categories (their greatest lower bound)

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(ConversionCategory a, ConversionCategory b)

toString back to summary

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

public String toString()

Overrides java.lang.Enum.toString.

Returns a pretty printed ConversionCategory.

Returns:String

Doc from java.lang.Enum.toString.

the name of this enum constant

Annotations

@Pure
@Override

union	back to summary
public static ConversionCategory union(ConversionCategory a, ConversionCategory b) Returns the union of two categories. This is seldomly needed. ConversionCategory.union(INT, TIME) == GENERAL; Parameters a:ConversionCategory a category b:ConversionCategory a category Returns:ConversionCategory the union of the two categories (their least upper bound)

union

back to summary

public static ConversionCategory union(ConversionCategory a, ConversionCategory b)

Returns the union of two categories. This is seldomly needed.

ConversionCategory.union(INT, TIME) == GENERAL;

Parameters

a:ConversionCategory: a category
b:ConversionCategory: a category

Returns:ConversionCategory

the union of the two categories (their least upper bound)

unwrapPrimitive	back to summary
private static @Nullable Class<? extends Object> unwrapPrimitive(Class<?> c) If the given class is a primitive wrapper, return the corresponding primitive class. Otherwise return null. Parameters c:Class<?> a class Returns:@Nullable Class<? extends Object> the unwrapped primitive, or null

unwrapPrimitive

back to summary

private static @Nullable Class<? extends Object> unwrapPrimitive(Class<?> c)

If the given class is a primitive wrapper, return the corresponding primitive class. Otherwise return null.

Parameters

c:Class<?>: a class

Returns:@Nullable Class<? extends Object>

the unwrapped primitive, or null

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

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

public final Enum ConversionCategory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail