com.fasterxml.jackson.databind.util.EnumValues Maven / Gradle / Ivy
Show all versions of jackson-databind Show documentation
package com.fasterxml.jackson.databind.util;
import com.fasterxml.jackson.databind.introspect.AnnotatedClass;
import java.util.*;
import com.fasterxml.jackson.core.SerializableString;
import com.fasterxml.jackson.databind.*;
import com.fasterxml.jackson.databind.cfg.EnumFeature;
import com.fasterxml.jackson.databind.cfg.MapperConfig;
/**
* Helper class used for storing String serializations of {@code Enum}s,
* to match to/from external representations.
*/
public final class EnumValues
implements java.io.Serializable
{
private static final long serialVersionUID = 1;
private final Class> _enumClass;
private final Enum[] _values;
private final SerializableString[] _textual;
private transient EnumMap _asMap;
private EnumValues(Class> enumClass, SerializableString[] textual)
{
_enumClass = enumClass;
_values = enumClass.getEnumConstants();
_textual = textual;
}
/**
* NOTE: do NOT call this if configuration may change, and choice between toString()
* and name() might change dynamically.
*
* @since 2.16
*/
public static EnumValues construct(SerializationConfig config, AnnotatedClass annotatedClass) {
if (config.isEnabled(SerializationFeature.WRITE_ENUMS_USING_TO_STRING)) {
return constructFromToString(config, annotatedClass);
}
return constructFromName(config, annotatedClass);
}
/**
* @deprecated Since 2.16, use {@link #constructFromName(MapperConfig, AnnotatedClass)} instead.
*/
@Deprecated
public static EnumValues constructFromName(MapperConfig config, Class> enumClass)
{
// Enum types with per-instance sub-classes need special handling
Class> enumCls = ClassUtil.findEnumType(enumClass);
Enum[] enumValues = enumCls.getEnumConstants();
if (enumValues == null) {
throw new IllegalArgumentException("Cannot determine enum constants for Class "+enumClass.getName());
}
String[] names = config.getAnnotationIntrospector().findEnumValues(enumCls, enumValues, new String[enumValues.length]);
SerializableString[] textual = new SerializableString[enumValues.length];
for (int i = 0, len = enumValues.length; i < len; ++i) {
Enum en = enumValues[i];
String name = names[i];
if (name == null) {
name = en.name();
}
if (config.isEnabled(EnumFeature.WRITE_ENUMS_TO_LOWERCASE)) {
name = name.toLowerCase();
}
textual[en.ordinal()] = config.compileString(name);
}
return construct(enumClass, textual);
}
/**
* @since 2.16
*/
public static EnumValues constructFromName(MapperConfig config, AnnotatedClass annotatedClass)
{
// prepare data
final AnnotationIntrospector ai = config.getAnnotationIntrospector();
final boolean useLowerCase = config.isEnabled(EnumFeature.WRITE_ENUMS_TO_LOWERCASE);
final Class enumCls0 = annotatedClass.getRawType();
final Class> enumCls = _enumClass(enumCls0);
final Enum[] enumConstants = _enumConstants(enumCls0);
// introspect
String[] names = ai.findEnumValues(config, annotatedClass,
enumConstants, new String[enumConstants.length]);
// build
SerializableString[] textual = new SerializableString[enumConstants.length];
for (int i = 0, len = enumConstants.length; i < len; ++i) {
Enum enumValue = enumConstants[i];
String name = names[i];
if (name == null) {
name = enumValue.name();
}
if (useLowerCase) {
name = name.toLowerCase();
}
textual[enumValue.ordinal()] = config.compileString(name);
}
return construct(enumCls, textual);
}
/**
* @since 2.16
*/
public static EnumValues constructFromToString(MapperConfig config, AnnotatedClass annotatedClass)
{
// prepare data
final AnnotationIntrospector ai = config.getAnnotationIntrospector();
final boolean useLowerCase = config.isEnabled(EnumFeature.WRITE_ENUMS_TO_LOWERCASE);
final Class enumCls0 = annotatedClass.getRawType();
final Class> enumCls = _enumClass(enumCls0);
final Enum[] enumConstants = _enumConstants(enumCls0);
// introspect
String[] names = new String[enumConstants.length];
if (ai != null) {
ai.findEnumValues(config, annotatedClass, enumConstants, names);
}
// build
SerializableString[] textual = new SerializableString[enumConstants.length];
for (int i = 0; i < enumConstants.length; i++) {
String name = names[i];
if (name == null) {
Enum en = enumConstants[i];
name = en.toString();
// 01-Feb-2024, tatu: [databind#4355] Nulls not great but... let's
// coerce into "" for backwards compatibility
if (name == null) {
name = "";
}
}
if (useLowerCase) {
name = name.toLowerCase();
}
textual[i] = config.compileString(name);
}
return construct(enumCls, textual);
}
/**
* @deprecated since 2.16; use {@link #constructFromToString(MapperConfig, AnnotatedClass)} instead
*/
@Deprecated
public static EnumValues constructFromToString(MapperConfig config, Class> enumClass)
{
Class> cls = ClassUtil.findEnumType(enumClass);
Enum[] values = cls.getEnumConstants();
if (values == null) { // can this ever occur?
throw new IllegalArgumentException("Cannot determine enum constants for Class "+enumClass.getName());
}
ArrayList external = new ArrayList<>(values.length);
for (Enum en : values) {
external.add(en.toString());
}
return construct(config, enumClass, external);
}
/**
* Returns String serializations of Enum name using an instance of {@link EnumNamingStrategy}.
*
* The output {@link EnumValues} should contain values that are symmetric to
* {@link EnumResolver#constructUsingEnumNamingStrategy(DeserializationConfig, AnnotatedClass, EnumNamingStrategy)}.
*
* @since 2.16
*/
public static EnumValues constructUsingEnumNamingStrategy(MapperConfig config, AnnotatedClass annotatedClass,
EnumNamingStrategy namingStrategy)
{
// prepare data
final AnnotationIntrospector ai = config.getAnnotationIntrospector();
final boolean useLowerCase = config.isEnabled(EnumFeature.WRITE_ENUMS_TO_LOWERCASE);
final Class enumCls0 = annotatedClass.getRawType();
final Class> enumCls = _enumClass(enumCls0);
final Enum[] enumConstants = _enumConstants(enumCls0);
// introspect
String[] names = new String[enumConstants.length];
if (ai != null) {
ai.findEnumValues(config, annotatedClass, enumConstants, names);
}
// build
SerializableString[] textual = new SerializableString[enumConstants.length];
for (int i = 0, len = enumConstants.length; i < len; i++) {
Enum enumValue = enumConstants[i];
String name = names[i];
if (name == null) {
name = namingStrategy.convertEnumToExternalName(enumValue.name());
}
if (useLowerCase) {
name = name.toLowerCase();
}
textual[i] = config.compileString(name);
}
return construct(enumCls, textual);
}
/**
* Returns String serializations of Enum name using an instance of {@link EnumNamingStrategy}.
*
* The output {@link EnumValues} should contain values that are symmetric to
* {@link EnumResolver#constructUsingEnumNamingStrategy(DeserializationConfig, AnnotatedClass, EnumNamingStrategy)}.
*
* @since 2.15
* @deprecated Since 2.16; use {@link #constructUsingEnumNamingStrategy(MapperConfig, AnnotatedClass, EnumNamingStrategy)} instead.
*/
@Deprecated
public static EnumValues constructUsingEnumNamingStrategy(MapperConfig config, Class> enumClass, EnumNamingStrategy namingStrategy) {
Class> cls = ClassUtil.findEnumType(enumClass);
Enum[] values = cls.getEnumConstants();
if (values == null) {
throw new IllegalArgumentException("Cannot determine enum constants for Class " + enumClass.getName());
}
ArrayList external = new ArrayList<>(values.length);
for (Enum en : values) {
external.add(namingStrategy.convertEnumToExternalName(en.name()));
}
return construct(config, enumClass, external);
}
/**
* @since 2.11
*/
public static EnumValues construct(MapperConfig config, Class> enumClass,
List externalValues) {
final int len = externalValues.size();
SerializableString[] textual = new SerializableString[len];
for (int i = 0; i < len; ++i) {
textual[i] = config.compileString(externalValues.get(i));
}
return construct(enumClass, textual);
}
/**
* @since 2.11
*/
public static EnumValues construct(Class> enumClass,
SerializableString[] externalValues) {
return new EnumValues(enumClass, externalValues);
}
/*
/**********************************************************************
/* Internal Helpers
/**********************************************************************
*/
@SuppressWarnings("unchecked")
protected static Class> _enumClass(Class enumCls0) {
return (Class>) enumCls0;
}
/**
* Helper method slightly different from {@link EnumResolver#_enumConstants(Class)},
* with same method name to keep calling methods more consistent.
*/
protected static Enum[] _enumConstants(Class enumCls) {
final Enum[] enumValues = ClassUtil.findEnumType(enumCls).getEnumConstants();
if (enumValues == null) {
throw new IllegalArgumentException("No enum constants for class "+enumCls.getName());
}
return enumValues;
}
/*
/**********************************************************************
/* Public API
/**********************************************************************
*/
public SerializableString serializedValueFor(Enum key) {
return _textual[key.ordinal()];
}
public Collection values() {
return Arrays.asList(_textual);
}
/**
* Convenience accessor for getting raw Enum instances.
*
* @since 2.6
*/
public List> enums() {
return Arrays.asList(_values);
}
/**
* Method used for serialization and introspection by core Jackson code.
*/
@SuppressWarnings({ "unchecked", "rawtypes" })
public EnumMap internalMap() {
EnumMap result = _asMap;
if (result == null) {
// Alas, need to create it in a round-about way, due to typing constraints...
Map,SerializableString> map = new LinkedHashMap,SerializableString>();
for (Enum en : _values) {
map.put(en, _textual[en.ordinal()]);
}
_asMap = result = new EnumMap(map);
}
return result;
}
/**
* @since 2.2
*/
public Class> getEnumClass() { return _enumClass; }
}