Update release notes, minor tweaks for #3212

Author: cowtowncoder

release-notes/CREDITS-2.x

@@ -1495,6 +1495,10 @@ Jordi Ortolá Ankum (Tomasito665@github)
   * Contributed #3613: Implement `float` and `boolean` to `String` coercion config
   (2.14.0)
 
+Felix Vaughan (FelixVaughan01@github)
+  * Contributed #3212: Add method `ObjectMapper.copyWith(JsonFactory)`
+  (2.14.0)
+
 Arnaud Solé (Bluexin@github)
   * Contributed #3505: Fix deduction deserializer with DefaultTypeResolverBuilder
   (2.14.0)

release-notes/VERSION-2.x

@@ -6,6 +6,9 @@ Project: jackson-databind
 
 Not yet released:
 
+#3212: Add method `ObjectMapper.copyWith(JsonFactory)`
+ (requested by @quaff)
+ (contributed by Felix V)
 #3624: Legacy `ALLOW_COERCION_OF_SCALARS` interacts poorly with Integer to
   Float coercion
 (contributed by Carter K)

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

@@ -595,9 +595,15 @@ protected ObjectMapper(ObjectMapper src)
         this(src, null);
     }
 
+    /**
+     * Copy constructor with {@link JsonFactory} override: mostly needed
+     * to support {@link #copyWith(JsonFactory)} method.
+     *
+     * @since 2.14
+     */
     protected ObjectMapper(ObjectMapper src, JsonFactory factory)
     {
-        _jsonFactory = factory != null ? factory : src._jsonFactory.copy();
+        _jsonFactory = (factory != null) ? factory : src._jsonFactory.copy();
         _jsonFactory.setCodec(this);
         _subtypeResolver = src._subtypeResolver.copy();
         _typeFactory = src._typeFactory;
@@ -608,10 +614,10 @@ protected ObjectMapper(ObjectMapper src, JsonFactory factory)
 
         RootNameLookup rootNames = new RootNameLookup();
         _serializationConfig = new SerializationConfig(src._serializationConfig,
-        _subtypeResolver, _mixIns, rootNames, _configOverrides);
+                _subtypeResolver, _mixIns, rootNames, _configOverrides);
         _deserializationConfig = new DeserializationConfig(src._deserializationConfig,
-        _subtypeResolver, _mixIns, rootNames, _configOverrides,
-        _coercionConfigs);
+                _subtypeResolver, _mixIns, rootNames, _configOverrides,
+                _coercionConfigs);
         _serializerProvider = src._serializerProvider.copy();
         _deserializationContext = src._deserializationContext.copy();
 
@@ -663,12 +669,12 @@ public ObjectMapper(JsonFactory jf,
         _configOverrides = new ConfigOverrides();
         _coercionConfigs = new CoercionConfigs();
         _serializationConfig = new SerializationConfig(base,
-                    _subtypeResolver, mixins, rootNames, _configOverrides,
-                    DatatypeFeatures.defaultFeatures());
+                _subtypeResolver, mixins, rootNames, _configOverrides,
+                DatatypeFeatures.defaultFeatures());
         _deserializationConfig = new DeserializationConfig(base,
-                    _subtypeResolver, mixins, rootNames, _configOverrides,
-                    _coercionConfigs,
-                    DatatypeFeatures.defaultFeatures());
+                _subtypeResolver, mixins, rootNames, _configOverrides,
+                _coercionConfigs,
+                DatatypeFeatures.defaultFeatures());
 
         // Some overrides we may need
         final boolean needOrder = _jsonFactory.requiresPropertyOrdering();
@@ -720,6 +726,20 @@ public ObjectMapper copy() {
         return new ObjectMapper(this);
     }
 
+    /**
+     * Method for creating a new {@link ObjectMapper} instance that
+     * has same initial configuration as this instance (similar to how
+     * {@link #copy()} works, with one additional difference: that of
+     * alternate underlying {@link JsonFactory} to use.
+     * instance.
+     * 
+     * @since 2.14
+     *
+     * @param factory Token stream factory to use for low-level streaming
+     *    reading (parsing) and writing (generation)
+     *
+     * @return Newly created mapper instance
+     */
     public ObjectMapper copyWith(JsonFactory factory) {
         _checkInvalidCopy(ObjectMapper.class);
         return new ObjectMapper(this, factory);
@@ -732,8 +752,8 @@ protected void _checkInvalidCopy(Class<?> exp)
     {
         if (getClass() != exp) {
             // 10-Nov-2016, tatu: could almost use `ClassUtil.verifyMustOverride()` but not quite
-            throw new IllegalStateException("Failed copy(): "+getClass().getName()
-                    +" (version: "+version()+") does not override copy(); it has to");
+            throw new IllegalStateException("Failed copy()/copyWith(): "+getClass().getName()
+                    +" (version: "+version()+") does not override copy()/copyWith(); it has to");
         }
     }
 

src/test/java/com/fasterxml/jackson/databind/ObjectMapperTest.java

@@ -217,15 +217,14 @@ public void testCopyWith() throws JsonProcessingException {
         ObjectMapper copiedMapper = mapper.copyWith(newFactory);
         String json = "{ \"color\" : \"Black\", \"free\" : \"true\", \"pages\" : \"204.04\" }";
         JsonNode readResult = copiedMapper.readTree(json);
-        //validate functionality
+        // validate functionality
         assertEquals("Black", readResult.get("color").asText());
         assertEquals(true, readResult.get("free").asBoolean());
         assertEquals(204, readResult.get("pages").asInt());
         String readResultAsString = "{\n  \"color\" : \"Black\",\n  \"free\" : \"true\",\n  \"pages\" : \"204.04\"\n}";
-        System.out.println(mapper.writeValueAsString(readResult));
         assertEquals(readResultAsString, mapper.writeValueAsString(readResult));
 
-        //validate properties
+        // validate properties
         Boolean mapperConfig1 = mapper._deserializationConfig.isEnabled(DeserializationFeature.FAIL_ON_NULL_FOR_PRIMITIVES);
         Boolean copiedMapperConfig1 = copiedMapper._deserializationConfig.isEnabled(DeserializationFeature.FAIL_ON_NULL_FOR_PRIMITIVES);
         Boolean mapperConfig2 = mapper._deserializationConfig.isEnabled(DeserializationFeature.READ_UNKNOWN_ENUM_VALUES_AS_NULL);