First part of #1888: merge ResolvableSerializer

Author: cowtowncoder

src/main/java/com/fasterxml/jackson/databind/JsonSerializer.java

@@ -29,8 +29,8 @@
  *<p>
  * If serializer is an aggregate one -- meaning it delegates handling of some
  * of its contents by using other serializer(s) -- it typically also needs
- * to implement {@link com.fasterxml.jackson.databind.ser.ResolvableSerializer},
- * which can locate secondary serializers needed. This is important to allow dynamic
+ * to implement {@link #resolve} which can locate secondary serializers needed.
+ * This is important to allow dynamic
  * overrides of serializers; separate call interface is needed to separate
  * resolution of secondary serializers (which may have cyclic link back
  * to serializer itself, directly or indirectly).
@@ -44,15 +44,34 @@
  * is passed information on property, and can create a newly configured
  * serializer for handling that particular property.
  *<p>
- * If both
- * {@link com.fasterxml.jackson.databind.ser.ResolvableSerializer} and
- * {@link com.fasterxml.jackson.databind.ser.ContextualSerializer}
- * are implemented, resolution of serializers occurs before
- * contextualization.
+ * Resolution of serializers occurs before contextualization.
  */
 public abstract class JsonSerializer<T>
     implements JsonFormatVisitable
 {
+    /*
+    /**********************************************************
+    /* Initialization, with former `ResolvableSerializer
+    /**********************************************************
+     */
+
+    /**
+     * Method called after {@link SerializerProvider} has registered
+     * the serializer, but before it has returned it to the caller.
+     * Called object can then resolve its dependencies to other types,
+     * including self-references (direct or indirect).
+     *<p>
+     * Note that this method does NOT return serializer, since resolution
+     * is not allowed to change actual serializer to use.
+     *
+     * @param provider Provider that has constructed serializer this method
+     *   is called on.
+     */
+    public void resolve(SerializerProvider provider)
+        throws JsonMappingException {
+        // Default implementation does nothing
+    }
+
     /*
     /**********************************************************
     /* Fluent factory methods for constructing decorated versions

src/main/java/com/fasterxml/jackson/databind/SerializerProvider.java

@@ -1022,7 +1022,7 @@ public boolean isUnknownTypeSerializer(JsonSerializer<?> ser) {
      * either given a {@link Class} to instantiate (with default constructor),
      * or an uninitialized serializer instance.
      * Either way, serialize will be properly resolved
-     * (via {@link com.fasterxml.jackson.databind.ser.ResolvableSerializer}) and/or contextualized
+     * (via {@link com.fasterxml.jackson.databind.JsonSerializer#resolve}) and/or contextualized
      * (via {@link com.fasterxml.jackson.databind.ser.ContextualSerializer}) as necessary.
      * 
      * @param annotated Annotated entity that contained definition
@@ -1455,19 +1455,15 @@ protected JsonSerializer<Object> _handleContextualResolvable(JsonSerializer<?> s
             BeanProperty property)
         throws JsonMappingException
     {
-        if (ser instanceof ResolvableSerializer) {
-            ((ResolvableSerializer) ser).resolve(this);
-        }
+        ser.resolve(this);
         return (JsonSerializer<Object>) handleSecondaryContextualization(ser, property);
     }
 
     @SuppressWarnings("unchecked")
     protected JsonSerializer<Object> _handleResolvable(JsonSerializer<?> ser)
         throws JsonMappingException
     {
-        if (ser instanceof ResolvableSerializer) {
-            ((ResolvableSerializer) ser).resolve(this);
-        }
+        ser.resolve(this);
         return (JsonSerializer<Object>) ser;
     }
 
@@ -1482,10 +1478,9 @@ protected final DateFormat _dateFormat()
         if (_dateFormat != null) {
             return _dateFormat;
         }
-        /* At this point, all timezone configuration should have occurred, with respect
-         * to default dateformat configuration. But we still better clone
-         * an instance as formatters are stateful, not thread-safe.
-         */
+        // At this point, all timezone configuration should have occurred, with respect
+        // to default dateformat configuration. But we still better clone
+        // an instance as formatters are stateful, not thread-safe.
         DateFormat df = _config.getDateFormat();
         _dateFormat = df = (DateFormat) df.clone();
         // [databind#939]: 26-Sep-2015, tatu: With 2.6, formatter has been (pre)configured

src/main/java/com/fasterxml/jackson/databind/ser/BeanSerializerFactory.java

@@ -775,11 +775,11 @@ protected BeanPropertyWriter _constructWriter(SerializerProvider prov,
                 accessor);
         // Unlike most other code paths, serializer produced
         // here will NOT be resolved or contextualized, unless done here, so:
-        if (annotatedSerializer instanceof ResolvableSerializer) {
-            ((ResolvableSerializer) annotatedSerializer).resolve(prov);
+        if (annotatedSerializer != null) {
+            annotatedSerializer.resolve(prov);
+            // 05-Sep-2013, tatu: should be primary property serializer so:
+            annotatedSerializer = prov.handlePrimaryContextualization(annotatedSerializer, property);
         }
-        // 05-Sep-2013, tatu: should be primary property serializer so:
-        annotatedSerializer = prov.handlePrimaryContextualization(annotatedSerializer, property);
         // And how about polymorphic typing? First special to cover JAXB per-field settings:
         TypeSerializer contentTypeSer = null;
         // 16-Feb-2014, cgc: contentType serializers for collection-like and map-like types

src/main/java/com/fasterxml/jackson/databind/ser/ContextualSerializer.java

@@ -10,8 +10,7 @@
  * have differing behavior depending on what kind of property is being serialized.
  *<p>
  * Note that in cases where serializer needs both contextualization and
- * resolution -- that is, implements both this interface and {@link ResolvableSerializer}
- * -- resolution via {@link ResolvableSerializer} occurs first, and contextual
+ * resolution, resolution occurs first, and contextual
  * resolution (via this interface) later on.
  */
 public interface ContextualSerializer

src/main/java/com/fasterxml/jackson/databind/ser/ResolvableSerializer.java

@@ -8,12 +8,10 @@
  * but before being used. This is typically used to resolve references
  * to other contained types; for example, bean serializers use this
  * to eagerly find serializers for contained field types.
- *<p>
- * Note that in cases where serializer needs both contextualization and
- * resolution -- that is, implements both this interface and {@link ContextualSerializer}
- * -- resolution via this interface occurs first, and contextual
- * resolution (using {@link ContextualSerializer}) later on.
+ *
+ * @deprecated Since 3.0: method demoted to <code>JsonSerializer</code>
  */
+@Deprecated
 public interface ResolvableSerializer
 {
     /**

src/main/java/com/fasterxml/jackson/databind/ser/SerializerCache.java

@@ -160,9 +160,7 @@ public void addAndResolveNonTypedSerializer(Class<?> type, JsonSerializer<Object
              *   this because while we do need to register instance first, we also must
              *   keep lock until resolution is complete.
              */
-            if (ser instanceof ResolvableSerializer) {
-                ((ResolvableSerializer) ser).resolve(provider);
-            }
+            ser.resolve(provider);
         }
     }
 
@@ -179,9 +177,7 @@ public void addAndResolveNonTypedSerializer(JavaType type, JsonSerializer<Object
              *   this because while we do need to register instance first, we also must
              *   keep lock until resolution is complete.
              */
-            if (ser instanceof ResolvableSerializer) {
-                ((ResolvableSerializer) ser).resolve(provider);
-            }
+            ser.resolve(provider);
         }
     }
 
@@ -202,9 +198,7 @@ public void addAndResolveNonTypedSerializer(Class<?> rawType, JavaType fullType,
             if ((ob1 == null) || (ob2 == null)) {
                 _readOnlyMap.set(null);
             }
-            if (ser instanceof ResolvableSerializer) {
-                ((ResolvableSerializer) ser).resolve(provider);
-            }
+            ser.resolve(provider);
         }
     }
 

src/main/java/com/fasterxml/jackson/databind/ser/std/BeanSerializerBase.java

@@ -32,7 +32,7 @@
 @SuppressWarnings("serial")
 public abstract class BeanSerializerBase
     extends StdSerializer<Object>
-    implements ContextualSerializer, ResolvableSerializer,
+    implements ContextualSerializer,
         JsonFormatVisitable
 {
     protected final static PropertyName NAME_FOR_OBJECT_REF = new PropertyName("#object-ref");
@@ -265,8 +265,8 @@ private final static BeanPropertyWriter[] rename(BeanPropertyWriter[] props,
      */
 
     /**
-     * We need to implement {@link ResolvableSerializer} to be able to
-     * properly handle cyclic type references.
+     * We need to resolve dependant serializers here
+     * to be able to properly handle cyclic type references.
      */
     @Override
     public void resolve(SerializerProvider provider)

src/main/java/com/fasterxml/jackson/databind/ser/std/StdDelegatingSerializer.java

@@ -9,7 +9,6 @@
 import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper;
 import com.fasterxml.jackson.databind.jsontype.TypeSerializer;
 import com.fasterxml.jackson.databind.ser.ContextualSerializer;
-import com.fasterxml.jackson.databind.ser.ResolvableSerializer;
 import com.fasterxml.jackson.databind.util.ClassUtil;
 import com.fasterxml.jackson.databind.util.Converter;
 
@@ -20,13 +19,11 @@
  *<p>
  * Note that although types may be related, they must not be same; trying
  * to do this will result in an exception.
- *
- * @since 2.1
  */
 @SuppressWarnings("serial")
 public class StdDelegatingSerializer
     extends StdSerializer<Object>
-    implements ContextualSerializer, ResolvableSerializer,
+    implements ContextualSerializer,
         JsonFormatVisitable
 {
     protected final Converter<Object,?> _converter;
@@ -95,9 +92,8 @@ protected StdDelegatingSerializer withDelegate(Converter<Object,?> converter,
     @Override
     public void resolve(SerializerProvider provider) throws JsonMappingException
     {
-        if ((_delegateSerializer != null)
-                && (_delegateSerializer instanceof ResolvableSerializer)) {
-            ((ResolvableSerializer) _delegateSerializer).resolve(provider);
+        if (_delegateSerializer != null) {
+            _delegateSerializer.resolve(provider);
         }
     }
 

src/test/java/com/fasterxml/jackson/databind/contextual/TestContextualSerialization.java

@@ -11,7 +11,6 @@
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import com.fasterxml.jackson.databind.module.SimpleModule;
 import com.fasterxml.jackson.databind.ser.ContextualSerializer;
-import com.fasterxml.jackson.databind.ser.ResolvableSerializer;
 
 /**
  * Test cases to verify that it is possible to define serializers
@@ -160,7 +159,7 @@ public JsonSerializer<?> createContextual(SerializerProvider prov, BeanProperty
 
     static class ContextualAndResolvable
         extends JsonSerializer<String>
-        implements ContextualSerializer, ResolvableSerializer
+        implements ContextualSerializer
     {
         protected int isContextual;
         protected int isResolved;

src/test/java/com/fasterxml/jackson/databind/jsontype/TestWithGenerics.java

@@ -10,7 +10,6 @@
 import com.fasterxml.jackson.annotation.JsonTypeInfo.Id;
 import com.fasterxml.jackson.databind.*;
 import com.fasterxml.jackson.databind.ser.BeanSerializerFactory;
-import com.fasterxml.jackson.databind.ser.ResolvableSerializer;
 
 public class TestWithGenerics extends BaseMapTest
 {
@@ -67,10 +66,7 @@ static class SomeObject {
         public String someValue = UUID.randomUUID().toString();
     }
 
-    // Beans for [JACKSON-430]
-    
     static class CustomJsonSerializer extends JsonSerializer<Object>
-        implements ResolvableSerializer
     {
         private final JsonSerializer<Object> beanSerializer;
 
@@ -96,9 +92,7 @@ public void serializeWithType( Object value, JsonGenerator jgen, SerializerProvi
         @Override
         public void resolve(SerializerProvider provider) throws JsonMappingException
         {
-            if (beanSerializer instanceof ResolvableSerializer) {
-                ((ResolvableSerializer) beanSerializer).resolve(provider);
-            }
+            beanSerializer.resolve(provider);
         }
     }