Merge branch '2.6'

cowtowncoder · cowtowncoder · commit 643a617a027b · 2015-09-24T22:04:54.000-07:00
diff --git a/release-notes/VERSION b/release-notes/VERSION
@@ -13,6 +13,8 @@ Project: jackson-databind
 
 2.6.3 (not yet released)
 
+#749: `EnumMap` serialization ignores `SerializationFeature.WRITE_ENUMS_USING_TO_STRING`
+ (reported by scubasau@github)
 #938: Regression: `StackOverflowError` with recursive types that contain `Map.Entry`
  (reported by jloisel@github)
 #940: Add missing `hashCode()` implementations for `JsonNode` types that did not have them
diff --git a/src/main/java/com/fasterxml/jackson/databind/ser/BasicSerializerFactory.java b/src/main/java/com/fasterxml/jackson/databind/ser/BasicSerializerFactory.java
@@ -237,13 +237,13 @@ public JsonSerializer<Object> createKeySerializer(SerializationConfig config,
                         }
                         ser = new JsonValueSerializer(m, delegate);
                     } else {
-                        ser = StdKeySerializers.getDefault();
+                        ser = StdKeySerializers.getFallbackKeySerializer(config, keyType.getRawClass());
                     }
                 }
             }
         }
         
-        // [Issue#120]: Allow post-processing
+        // [databind#120]: Allow post-processing
         if (_factoryConfig.hasSerializerModifiers()) {
             for (BeanSerializerModifier mod : _factoryConfig.serializerModifiers()) {
                 ser = mod.modifyKeySerializer(config, keyType, beanDesc, ser);
diff --git a/src/main/java/com/fasterxml/jackson/databind/ser/std/StdKeySerializer.java b/src/main/java/com/fasterxml/jackson/databind/ser/std/StdKeySerializer.java
@@ -8,6 +8,7 @@
 import com.fasterxml.jackson.databind.JavaType;
 import com.fasterxml.jackson.databind.JsonMappingException;
 import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.SerializationFeature;
 import com.fasterxml.jackson.databind.SerializerProvider;
 import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper;
 
@@ -22,21 +23,31 @@ public class StdKeySerializer extends StdSerializer<Object>
     public StdKeySerializer() { super(Object.class); }
 
     @Override
-    public void serialize(Object value, JsonGenerator jgen, SerializerProvider provider) throws IOException {
+    public void serialize(Object value, JsonGenerator g, SerializerProvider provider) throws IOException {
         String str;
         Class<?> cls = value.getClass();
-        
+
         if (cls == String.class) {
             str = (String) value;
-        } else if (Date.class.isAssignableFrom(cls)) {
-            provider.defaultSerializeDateKey((Date) value, jgen);
+        } else if (cls.isEnum()) {
+            // 24-Sep-2015, tatu: Minor improvement over older (2.6.2 and before) code: at least
+            //     use name/toString() variation for as per configuration
+            Enum<?> en = (Enum<?>) value;
+
+            if (provider.isEnabled(SerializationFeature.WRITE_ENUMS_USING_TO_STRING)) {
+                str = en.toString();
+            } else {
+                str = en.name();
+            }
+        } else if (value instanceof Date) {
+            provider.defaultSerializeDateKey((Date) value, g);
             return;
         } else if (cls == Class.class) {
             str = ((Class<?>) value).getName();
         } else {
             str = value.toString();
         }
-        jgen.writeFieldName(str);
+        g.writeFieldName(str);
     }
 
     @Override
diff --git a/src/main/java/com/fasterxml/jackson/databind/ser/std/StdKeySerializers.java b/src/main/java/com/fasterxml/jackson/databind/ser/std/StdKeySerializers.java
@@ -26,6 +26,10 @@ private StdKeySerializers() { }
     public static JsonSerializer<Object> getStdKeySerializer(SerializationConfig config,
             Class<?> rawKeyType, boolean useDefault)
     {
+        // 24-Sep-2015, tatu: Important -- should ONLY consider types for which `@JsonValue`
+        //    can not be used, since caller has not yet checked for that annotation
+        //    This is why Enum types are not handled here quite yet
+
         if (rawKeyType != null) {
             if (rawKeyType == String.class) {
                 return DEFAULT_STRING_SERIALIZER;
@@ -43,14 +47,31 @@ public static JsonSerializer<Object> getStdKeySerializer(SerializationConfig con
             if (Calendar.class.isAssignableFrom(rawKeyType)) {
                 return new Default(Default.TYPE_CALENDAR, rawKeyType);
             }
-            // other types we know convert properly with 'toString()'?
+            // other JDK types we know convert properly with 'toString()'?
             if (rawKeyType == java.util.UUID.class) {
                 return new Default(Default.TYPE_TO_STRING, rawKeyType);
             }
+
         }
         return useDefault ? DEFAULT_KEY_SERIALIZER : null;
     }
 
+    /**
+     * Method called if no specified key serializer was located; will return a
+     * "default" key serializer.
+     *
+     * @since 2.7
+     */
+    public static JsonSerializer<Object> getFallbackKeySerializer(SerializationConfig config,
+            Class<?> rawKeyType) {
+        if (rawKeyType != null) {
+            if (rawKeyType.isEnum()) {
+                return new Default(Default.TYPE_ENUM, rawKeyType);
+            }
+        }
+        return DEFAULT_KEY_SERIALIZER;
+    }
+    
     /**
      * @deprecated Since 2.5
      */
@@ -59,10 +80,13 @@ public static JsonSerializer<Object> getStdKeySerializer(JavaType keyType) {
         return getStdKeySerializer(null, keyType.getRawClass(), true);
     }
 
+    /**
+     * @deprecated since 2.7
+     */
     public static JsonSerializer<Object> getDefault() {
         return DEFAULT_KEY_SERIALIZER;
     }
-    
+
     /*
     /**********************************************************
     /* Standard implementations used
@@ -73,7 +97,8 @@ public static class Default extends StdSerializer<Object> {
         final static int TYPE_DATE = 1;
         final static int TYPE_CALENDAR = 2;
         final static int TYPE_CLASS = 3;
-        final static int TYPE_TO_STRING = 4;
+        final static int TYPE_ENUM = 4;
+        final static int TYPE_TO_STRING = 5;
 
         protected final int _typeId;
         
@@ -83,20 +108,27 @@ public Default(int typeId, Class<?> type) {
         }
 
         @Override
-        public void serialize(Object value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonGenerationException {
+        public void serialize(Object value, JsonGenerator g, SerializerProvider provider) throws IOException {
             switch (_typeId) {
             case TYPE_DATE:
-                provider.defaultSerializeDateKey((Date)value, jgen);
+                provider.defaultSerializeDateKey((Date)value, g);
                 break;
             case TYPE_CALENDAR:
-                provider.defaultSerializeDateKey(((Calendar) value).getTimeInMillis(), jgen);
+                provider.defaultSerializeDateKey(((Calendar) value).getTimeInMillis(), g);
                 break;
             case TYPE_CLASS:
-                jgen.writeFieldName(((Class<?>)value).getName());
+                g.writeFieldName(((Class<?>)value).getName());
+                break;
+            case TYPE_ENUM:
+                {
+                    String str = provider.isEnabled(SerializationFeature.WRITE_ENUMS_USING_TO_STRING)
+                            ? value.toString() : ((Enum<?>) value).name();
+                    g.writeFieldName(str);
+                }
                 break;
             case TYPE_TO_STRING:
             default:
-                jgen.writeFieldName(value.toString());
+                g.writeFieldName(value.toString());
             }
         }
     }
@@ -106,11 +138,11 @@ public static class StringKeySerializer extends StdSerializer<Object>
         public StringKeySerializer() { super(String.class, false); }
 
         @Override
-        public void serialize(Object value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonGenerationException {
-            jgen.writeFieldName((String) value);
+        public void serialize(Object value, JsonGenerator g, SerializerProvider provider) throws IOException {
+            g.writeFieldName((String) value);
         }
     }
-    
+
     /*
     /**********************************************************
     /* Deprecated implementations: to be removed in future
@@ -124,8 +156,8 @@ public static class DateKeySerializer extends StdSerializer<Date> {
         public DateKeySerializer() { super(Date.class); }
         
         @Override
-        public void serialize(Date value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonGenerationException {
-            provider.defaultSerializeDateKey(value, jgen);
+        public void serialize(Date value, JsonGenerator g, SerializerProvider provider) throws IOException {
+            provider.defaultSerializeDateKey(value, g);
         }
     }
 
@@ -134,10 +166,10 @@ public static class CalendarKeySerializer extends StdSerializer<Calendar> {
         protected final static JsonSerializer<?> instance = new CalendarKeySerializer();
 
         public CalendarKeySerializer() { super(Calendar.class); }
-        
+
         @Override
-        public void serialize(Calendar value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonGenerationException {
-            provider.defaultSerializeDateKey(value.getTimeInMillis(), jgen);
+        public void serialize(Calendar value, JsonGenerator g, SerializerProvider provider) throws IOException {
+            provider.defaultSerializeDateKey(value.getTimeInMillis(), g);
         }
     }
 }
diff --git a/src/test/java/com/fasterxml/jackson/databind/misc/TestJSONP.java b/src/test/java/com/fasterxml/jackson/databind/misc/TestJSONP.java
@@ -1,4 +1,4 @@
-package com.fasterxml.jackson.databind.ser;
+package com.fasterxml.jackson.databind.misc;
 
 import com.fasterxml.jackson.databind.*;
 import com.fasterxml.jackson.databind.type.TypeFactory;
diff --git a/src/test/java/com/fasterxml/jackson/databind/module/TestCustomEnumKeyDeserializer.java b/src/test/java/com/fasterxml/jackson/databind/module/TestCustomEnumKeyDeserializer.java
@@ -5,7 +5,6 @@
 import java.io.IOException;
 import java.util.*;
 
-import org.junit.Ignore;
 import org.junit.Test;
 
 import com.fasterxml.jackson.core.*;
@@ -106,27 +105,6 @@ public Class<TestEnum> handledType() {
         }
     }
 
-    static class TestEnumModule extends SimpleModule {
-
-        public TestEnumModule() {
-            super(Version.unknownVersion());
-        }
-
-        @Override
-        public void setupModule(SetupContext context) {
-            context.setMixInAnnotations(TestEnum.class, TestEnumMixin.class);
-            SimpleSerializers keySerializers = new SimpleSerializers();
-            keySerializers.addSerializer(new TestEnumKeySerializer());
-            context.addKeySerializers(keySerializers);
-        }
-
-        public static ObjectMapper setupObjectMapper(ObjectMapper mapper) {
-            final TestEnumModule module = new TestEnumModule();
-            mapper.registerModule(module);
-            return mapper;
-        }
-    }
-
     static class Bean {
         private File rootDirectory;
         private String licenseString;
@@ -157,6 +135,20 @@ public void setReplacements(Map<TestEnum, Map<String, String>> replacements) {
         }
     }
 
+    static class TestEnumModule extends SimpleModule {
+        public TestEnumModule() {
+            super(Version.unknownVersion());
+        }
+
+        @Override
+        public void setupModule(SetupContext context) {
+            context.setMixInAnnotations(TestEnum.class, TestEnumMixin.class);
+            SimpleSerializers keySerializers = new SimpleSerializers();
+            keySerializers.addSerializer(new TestEnumKeySerializer());
+            context.addKeySerializers(keySerializers);
+        }
+    }
+
     /*
     /**********************************************************
     /* Test methods
@@ -169,10 +161,11 @@ public void testWithEnumKeys() throws Exception {
         ObjectMapper plainObjectMapper = new ObjectMapper();
         JsonNode tree = plainObjectMapper.readTree(aposToQuotes("{'red' : [ 'a', 'b']}"));
 
-        ObjectMapper fancyObjectMapper = TestEnumModule.setupObjectMapper(new ObjectMapper());
+        ObjectMapper fancyObjectMapper = new ObjectMapper().registerModule(new TestEnumModule());
+
         // this line is might throw with Jackson 2.6.2.
-        Map<TestEnum, Set<String>> map = fancyObjectMapper.convertValue(tree, new TypeReference<Map<TestEnum, Set<String>>>() {
-        });
+        Map<TestEnum, Set<String>> map = fancyObjectMapper.convertValue(tree,
+                new TypeReference<Map<TestEnum, Set<String>>>() { } );
         assertNotNull(map);
     }
 
@@ -181,15 +174,18 @@ public void testWithEnumKeys() throws Exception {
 //    public void testWithTree749() throws Exception
     public void withTree749() throws Exception
     {
+        ObjectMapper mapper = new ObjectMapper().registerModule(new TestEnumModule());
+
         Map<KeyEnum, Object> inputMap = new LinkedHashMap<KeyEnum, Object>();
         Map<TestEnum, Map<String, String>> replacements = new LinkedHashMap<TestEnum, Map<String, String>>();
         Map<String, String> reps = new LinkedHashMap<String, String>();
         reps.put("1", "one");
         replacements.put(TestEnum.GREEN, reps);
         inputMap.put(KeyEnum.replacements, replacements);
-        ObjectMapper mapper = TestEnumModule.setupObjectMapper(new ObjectMapper());
+
         JsonNode tree = mapper.valueToTree(inputMap);
         ObjectNode ob = (ObjectNode) tree;
+
         JsonNode inner = ob.get("replacements");
         String firstFieldName = inner.fieldNames().next();
         assertEquals("green", firstFieldName);
diff --git a/src/test/java/com/fasterxml/jackson/databind/ser/TestEnumSerialization.java b/src/test/java/com/fasterxml/jackson/databind/ser/TestEnumSerialization.java

Original file line number	Diff line number	Diff line change
`@@ -237,13 +237,13 @@ public JsonSerializer<Object> createKeySerializer(SerializationConfig config,`
`237`	`237`	`}`
`238`	`238`	`ser = new JsonValueSerializer(m, delegate);`
`239`	`239`	`} else {`
`240`		`- ser = StdKeySerializers.getDefault();`
	`240`	`+ ser = StdKeySerializers.getFallbackKeySerializer(config, keyType.getRawClass());`
`241`	`241`	`}`
`242`	`242`	`}`
`243`	`243`	`}`
`244`	`244`	`}`
`245`	`245`
`246`		`- // [Issue#120]: Allow post-processing`
	`246`	`+ // [databind#120]: Allow post-processing`
`247`	`247`	`if (_factoryConfig.hasSerializerModifiers()) {`
`248`	`248`	`for (BeanSerializerModifier mod : _factoryConfig.serializerModifiers()) {`
`249`	`249`	`ser = mod.modifyKeySerializer(config, keyType, beanDesc, ser);`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package com.fasterxml.jackson.databind.ser;`
	`1`	`+package com.fasterxml.jackson.databind.misc;`
`2`	`2`
`3`	`3`	`import com.fasterxml.jackson.databind.*;`
`4`	`4`	`import com.fasterxml.jackson.databind.type.TypeFactory;`