Jackson deserializing into Map with an Enum Key, POJO Value

java json serialization jackson jsonserializer
ecbrodie picture ecbrodie · Nov 15, 2012 · Viewed 13.4k times · Source

I am trying to deserialize JSON into a Java POJO using Jackson. Without giving away confidential information, here is an example stack trace when ObjectMapper's deserialization fails:

org.codehaus.jackson.map.JsonMappingException: Can not construct Map key of type com.example.MyEnum from String "coins": not a valid representation: Can not construct Map key of type com.example.MyEnum from String "coins": not one of values for Enum class

My JSON looks like this:

"foo": {
    "coins": null,
    ...
}

And the class I want to deserialize into has this field:

private Map<MyEnum, MyPojo> foo;

And my enum type looks like this:

public enum MyEnum {
    COINS("coins"),
    ...
}

I do realize that I am trying to deserialize a null value. But I believe this should still work: the result of the deserialization should be equivalent to having a Map with foo.put(MyEnum.COINS, null), which is indeed a valid Java instruction. Help is much appreciated, thanks in advance.

Answer

StaxMan picture StaxMan · Nov 16, 2012

In addition to one good solution presented (factory method), there are 2 other ways:

  • If 'MyEnum.toString()' would return "coins", you can make Jackson use "toString()" over "name()"with ObjectMapper.enable(DeserializationFeature.READ_ENUMS_USING_TO_STRING)
  • You could add some other method to return id to use, and mark that method with @JsonValue annotation (you can actually use that on toString() as well, instead of enabling above feature) -- if that annotation exists, value returned by that method is used as the id.

Related questions

How do I use a custom Serializer with Jackson?

I have two Java classes that I want to serialize to JSON using Jackson: public class User { public final int id; public final String name; public User(int id, String name) { this.id = id; this.name = name; } } public class Item { …

Read More
Jackson JSON custom serialization for certain fields

Is there a way using Jackson JSON Processor to do custom field level serialization? For example, I'd like to have the class public class Person { public String name; public int age; public int favoriteNumber; } serialized to the follow JSON: { "name": "…

Read More
Why when a constructor is annotated with @JsonCreator, its arguments must be annotated with @JsonProperty?

In Jackson, when you annotate a constructor with @JsonCreator, you must annotate its arguments with @JsonProperty. So this constructor public Point(double x, double y) { this.x = x; this.y = y; } becomes this: @JsonCreator public Point(@JsonProperty("x") double x, @…

Read More