com.fasterxml.jackson.databind.util.EnumValues Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jackson-databind Show documentation
General data-binding functionality for Jackson: works on core streaming API
There is a newer version: 2.17.0
package com.fasterxml.jackson.databind.util;

import java.util.*;

import com.fasterxml.jackson.core.SerializableString;
import com.fasterxml.jackson.databind.*;
import com.fasterxml.jackson.databind.cfg.MapperConfig;

/**
 * Helper class used for storing String serializations of
 * enumerations.
 */
public final class EnumValues
{
    private final Class> _enumClass;
    
    /**
     * Use a more optimized String value here, to possibly speed up
     * serialization.
     */
    private final EnumMap _values;

    @SuppressWarnings({ "unchecked", "rawtypes" })
    private EnumValues(Class> enumClass, Map,SerializableString> v) {
        _enumClass = enumClass;
        _values = new EnumMap(v);
    }

    /**
     * NOTE: do NOT call this if configuration may change, and choice between toString()
     *   and name() might change dynamically.
     */
    public static EnumValues construct(SerializationConfig config, Class> enumClass) {
        if (config.isEnabled(SerializationFeature.WRITE_ENUMS_USING_TO_STRING)) {
            return constructFromToString(config, enumClass);
        }
        return constructFromName(config, enumClass);
    }

    public static EnumValues constructFromName(MapperConfig config, Class> enumClass)
    {
        // Enum types with per-instance sub-classes need special handling
        Class> cls = ClassUtil.findEnumType(enumClass);
        Enum[] values = cls.getEnumConstants();
        if (values != null) {
            // Type juggling... unfortunate
            Map,SerializableString> map = new HashMap,SerializableString>();
            for (Enum en : values) {
                String value = config.getAnnotationIntrospector().findEnumValue(en);
                map.put(en, config.compileString(value));
            }
            return new EnumValues(enumClass, map);
        }
        throw new IllegalArgumentException("Can not determine enum constants for Class "+enumClass.getName());
    }

    public static EnumValues constructFromToString(MapperConfig config, Class> enumClass)
    {
        Class> cls = ClassUtil.findEnumType(enumClass);
        Enum[] values = cls.getEnumConstants();
        if (values != null) {
            // Type juggling... unfortunate
            Map,SerializableString> map = new HashMap,SerializableString>();
            for (Enum en : values) {
                map.put(en, config.compileString(en.toString()));
            }
            return new EnumValues(enumClass, map);
        }
        throw new IllegalArgumentException("Can not determine enum constants for Class "+enumClass.getName());
    }

    public SerializableString serializedValueFor(Enum key) { return _values.get(key); }
    public Collection values() { return _values.values(); }

    /**
     * Method used for serialization and introspection by core Jackson code.
     */
    public EnumMap internalMap() { return _values; }

    /**
     * @since 2.2
     */
    public Class> getEnumClass() { return _enumClass; }
}