Fixed #2828 (although follow-up clean up needed, so first part)

Author: cowtowncoder

Diff for: release-notes/VERSION-2.x

@@ -6,7 +6,7 @@ Project: jackson-databind
 
 2.13.0 (not yet released)
 
-No changes since 2.12
+#2828: Add `DatabindException` as intermediate subtype of `JsonMappingException`
 
 2.12.1 (08-Jan-2021)
 

Diff for: src/main/java/com/fasterxml/jackson/databind/DatabindException.java

@@ -0,0 +1,36 @@
+package com.fasterxml.jackson.databind;
+
+import com.fasterxml.jackson.core.JsonLocation;
+import com.fasterxml.jackson.core.JsonProcessingException;
+
+/**
+ * Intermediate base class for all databind level processing problems, as
+ * distinct from stream-level problems or I/O issues below.
+ *<p>
+ * Added in 2.13 to eventually replace {@link com.fasterxml.jackson.databind.JsonMappingException};
+ * for 2.x will allow limited use as target (as catching it will also catch mapping exception)
+ * but will not be constructed or thrown directly.
+ *
+ * @since 2.13
+ */
+public abstract class DatabindException
+    extends JsonProcessingException
+{
+    private static final long serialVersionUID = 3L;
+
+    protected DatabindException(String msg, JsonLocation loc, Throwable rootCause) {
+        super(msg, loc, rootCause);
+    }
+
+    protected DatabindException(String msg) {
+        super(msg);
+    }
+
+    protected DatabindException(String msg, JsonLocation loc) {
+        this(msg, loc, null);
+    }
+
+    protected DatabindException(String msg, Throwable rootCause) {
+        this(msg, null, rootCause);
+    }
+}

Diff for: src/main/java/com/fasterxml/jackson/databind/JsonMappingException.java

@@ -21,9 +21,9 @@
  * troubleshooting.
  */
 public class JsonMappingException
-    extends JsonProcessingException
+    extends DatabindException // @since 2.13
 {
-    private static final long serialVersionUID = 1L;
+    private static final long serialVersionUID = 3L;
 
     /**
      * Let's limit length of reference chain, to limit damage in cases

Diff for: src/main/java/com/fasterxml/jackson/databind/ObjectMapper.java

@@ -2276,7 +2276,7 @@ protected void _reportUndetectableSource(Object src) throws StreamReadException
      * Method called to locate deserializer for the passed root-level value.
      */
     protected JsonDeserializer<Object> _findRootDeserializer(DeserializationContext ctxt)
-        throws JsonMappingException
+        throws DatabindException
     {
         if (_rootDeserializer != null) {
             return _rootDeserializer;
@@ -2306,7 +2306,7 @@ protected JsonDeserializer<Object> _findRootDeserializer(DeserializationContext
      * @since 2.6
      */
     protected JsonDeserializer<Object> _findTreeDeserializer(DeserializationContext ctxt)
-        throws JsonMappingException
+        throws DatabindException
     {
         final JavaType nodeType = _jsonNodeType();
         JsonDeserializer<Object> deser = _rootDeserializers.get(nodeType);

Diff for: src/main/java/com/fasterxml/jackson/databind/ObjectReader.java

@@ -1022,7 +1022,7 @@ public void writeValue(JsonGenerator g, Object value) throws IOException
      * JSON output, written to File provided.
      */
     public void writeValue(File resultFile, Object value)
-        throws IOException, StreamWriteException, JsonMappingException
+        throws IOException, StreamWriteException, DatabindException
     {
         _writeValueAndClose(createGenerator(resultFile, JsonEncoding.UTF8), value);
     }
@@ -1039,7 +1039,7 @@ public void writeValue(File resultFile, Object value)
      * is closed).
      */
     public void writeValue(OutputStream out, Object value)
-        throws IOException, StreamWriteException, JsonMappingException
+        throws IOException, StreamWriteException, DatabindException
     {
         _writeValueAndClose(createGenerator(out, JsonEncoding.UTF8), value);
     }
@@ -1055,7 +1055,7 @@ public void writeValue(OutputStream out, Object value)
      * is closed).
      */
     public void writeValue(Writer w, Object value)
-        throws IOException, StreamWriteException, JsonMappingException
+        throws IOException, StreamWriteException, DatabindException
     {
         _writeValueAndClose(createGenerator(w), value);
     }
@@ -1064,7 +1064,7 @@ public void writeValue(Writer w, Object value)
      * @since 2.8
      */
     public void writeValue(DataOutput out, Object value)
-        throws IOException, StreamWriteException, JsonMappingException
+        throws IOException, StreamWriteException, DatabindException
     {
         _writeValueAndClose(createGenerator(out), value);
     }
@@ -1135,7 +1135,8 @@ public byte[] writeValueAsBytes(Object value)
      * 
      * @since 2.2
      */
-    public void acceptJsonFormatVisitor(JavaType type, JsonFormatVisitorWrapper visitor) throws JsonMappingException
+    public void acceptJsonFormatVisitor(JavaType type, JsonFormatVisitorWrapper visitor)
+        throws JsonMappingException
     {
         _assertNotNull("type", type);
         _assertNotNull("visitor", visitor);
@@ -1145,7 +1146,9 @@ public void acceptJsonFormatVisitor(JavaType type, JsonFormatVisitorWrapper visi
     /**
      * Since 2.6
      */
-    public void acceptJsonFormatVisitor(Class<?> type, JsonFormatVisitorWrapper visitor) throws JsonMappingException {
+    public void acceptJsonFormatVisitor(Class<?> type, JsonFormatVisitorWrapper visitor)
+        throws JsonMappingException
+    {
         _assertNotNull("type", type);
         _assertNotNull("visitor", visitor);
         acceptJsonFormatVisitor(_config.constructType(type), visitor);
@@ -1482,7 +1485,7 @@ public Prefetch forRootType(ObjectWriter parent, JavaType newType) {
                                 ((TypeWrappedSerializer) ser).typeSerializer());
                     }
                     return new Prefetch(newType, ser, null);
-                } catch (JsonMappingException e) {
+                } catch (DatabindException e) {
                     // need to swallow?
                     ;
                 }

Diff for: src/main/java/com/fasterxml/jackson/databind/ObjectWriter.java

@@ -276,18 +276,18 @@ public void testWrapExceptions() throws Exception
 
         try {
             mapper.readValue("[{}]", new TypeReference<List<SomeObject>>() {});
-        } catch (JsonMappingException exc) {
+        } catch (DatabindException exc) {
             assertEquals("I want to catch this exception", exc.getOriginalMessage());
         } catch (RuntimeException exc) {
-            fail("The RuntimeException should have been wrapped with a JsonMappingException.");
+            fail("The RuntimeException should have been wrapped with a DatabindException.");
         }
 
         ObjectMapper mapperNoWrap = new ObjectMapper();
         mapperNoWrap.disable(DeserializationFeature.WRAP_EXCEPTIONS);
 
         try {
             mapperNoWrap.readValue("[{}]", new TypeReference<List<SomeObject>>() {});
-        } catch (JsonMappingException exc) {
+        } catch (DatabindException exc) {
             fail("It should not have wrapped the RuntimeException.");
         } catch (RuntimeException exc) {
             assertEquals("I want to catch this exception", exc.getMessage());

Diff for: src/test/java/com/fasterxml/jackson/databind/deser/jdk/CollectionDeserTest.java

@@ -34,7 +34,7 @@ public void testRootBeans() throws Exception
         try {
             bean = it.nextValue();
             fail("Should not have succeeded");
-        } catch (JsonMappingException e) {
+        } catch (DatabindException e) {
             verifyException(e, "Unrecognized field \"x\"");
         }
         // 21-May-2015, tatu: With [databind#734], recovery, we now know there's no more data!
@@ -59,7 +59,7 @@ public void testSimpleRootRecovery() throws Exception
         // second one problematic
         try {
             it.nextValue();
-        } catch (JsonMappingException e) {
+        } catch (DatabindException e) {
             verifyException(e, "Unrecognized field \"foo\"");
         }
 
@@ -88,7 +88,7 @@ public void testSimpleArrayRecovery() throws Exception
         // second one problematic
         try {
             it.nextValue();
-        } catch (JsonMappingException e) {
+        } catch (DatabindException e) {
             verifyException(e, "Unrecognized field \"foo\"");
         }
 

Diff for: src/test/java/com/fasterxml/jackson/databind/seq/ReadRecoveryTest.java

@@ -1,14 +1,8 @@
 package com.fasterxml.jackson.databind.struct;
 
-import com.fasterxml.jackson.annotation.JsonProperty;
-import com.fasterxml.jackson.annotation.JsonTypeInfo;
-import com.fasterxml.jackson.annotation.JsonTypeName;
-import com.fasterxml.jackson.annotation.JsonUnwrapped;
-import com.fasterxml.jackson.databind.BaseMapTest;
-import com.fasterxml.jackson.databind.JsonMappingException;
-import com.fasterxml.jackson.databind.MapperFeature;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.databind.SerializationFeature;
+import com.fasterxml.jackson.annotation.*;
+
+import com.fasterxml.jackson.databind.*;
 
 // Tests for [#81]
 public class TestUnwrappedWithTypeInfo extends BaseMapTest
@@ -63,7 +57,7 @@ public void testDefaultUnwrappedWithTypeInfo() throws Exception
 	    try {
 	        mapper.writeValueAsString(outer);
 	         fail("Expected exception to be thrown.");
-	    } catch (JsonMappingException ex) {
+	    } catch (DatabindException ex) {
 	        verifyException(ex, "requires use of type information");
 	    }
 	}

Diff for: src/test/java/com/fasterxml/jackson/databind/struct/TestUnwrappedWithTypeInfo.java

@@ -24,7 +24,7 @@ public void testFailOnUnknownPropertyUnwrapped() throws Exception
         try {
             MAPPER.readValue(aposToQuotes(JSON), A.class);
             fail("Exception was not thrown on unkown property");
-        } catch (JsonMappingException e) {
+        } catch (DatabindException e) {
             verifyException(e, "Unrecognized field");
         }
     }