Merge branch '2.10'

Author: cowtowncoder

release-notes/VERSION-2.x

@@ -6,6 +6,8 @@ Project: jackson-databind
 
 2.10.0.pr2 (not yet released)
 
+#2237: Add "required" methods in `JsonNode`: `required(String | int)`,
+  `requiredAt(JsonPointer)`
 #2331: `JsonMappingException` through nested getter with generic wildcard return type
  (reported by sunchezz89@github)
 #2336: `MapDeserializer` can not merge `Map`s with polymorphic values

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

@@ -389,7 +389,7 @@ public final boolean isBinary() {
      * if node is a JSON String representing integral number, or boolean.
      */
     public boolean canConvertToLong() { return false; }
-    
+
     /*
     /**********************************************************************
     /* Public API, straight value access
@@ -477,7 +477,7 @@ public byte[] binaryValue() throws IOException {
      *   nodes.
      */
     public long longValue() { return 0L; }
-    
+
     /**
      * Returns 32-bit floating value for this node, <b>if and only if</b>
      * this node is numeric ({@link #isNumber} returns true). For other
@@ -655,6 +655,68 @@ public boolean asBoolean(boolean defaultValue) {
         return defaultValue;
     }
 
+    /*
+    /**********************************************************************
+    /* Public API, extended traversal (2.10) with "required()"
+    /**********************************************************************
+     */
+
+    /**
+     * @since 2.10
+     */
+    public <T extends JsonNode> T require() {
+        return _this();
+    }
+
+    /**
+     * @since 2.10
+     */
+    public <T extends JsonNode> T requireNonNull() {
+        return _this();
+    }
+
+    /**
+     * @since 2.10
+     */
+    public JsonNode required(String fieldName) {
+        return _reportRequiredViolation("Node of type `%s` has no fields", getClass().getName());
+    }
+
+    /**
+     * @since 2.10
+     */
+    public JsonNode required(int index) {
+        return _reportRequiredViolation("Node of type `%s` has no indexed values", getClass().getName());
+    }
+
+    /**
+     * @since 2.10
+     */
+    public JsonNode requiredAt(String pathExpr) {
+        return requiredAt(JsonPointer.compile(pathExpr));
+    }
+
+    /**
+     * @since 2.10
+     */
+    public final JsonNode requiredAt(final JsonPointer pathExpr) {
+        JsonPointer currentExpr = pathExpr;
+        JsonNode curr = this;
+
+        // Note: copied from `at()`
+        while (true) {
+            if (currentExpr.matches()) {
+                return curr;
+            }
+            curr = curr._at(currentExpr);
+            if (curr == null) {
+                _reportRequiredViolation("No node at '%s' (unmatched part: '%s')",
+                        pathExpr, currentExpr);
+            }
+            currentExpr = currentExpr.tail();
+        }
+    }
+
     /*
     /**********************************************************************
     /* Public API, value find / existence check methods
@@ -971,4 +1033,25 @@ public String toPrettyString() {
      */
     @Override
     public abstract boolean equals(Object o);
+
+    /*
+    /**********************************************************************
+    /* Helper methods,  for sub-classes
+    /**********************************************************************
+     */
+
+    // @since 2.10
+    @SuppressWarnings("unchecked")
+    protected <T extends JsonNode> T _this() {
+        return (T) this;
+    }
+
+    /**
+     * Helper method that throws {@link IllegalArgumentException} as a result of
+     * violating "required-constraint" for this node (for {@link #require() or related
+     * methods).
+     */
+    protected <T> T _reportRequiredViolation(String msgTemplate, Object...args) {
+        throw new IllegalArgumentException(String.format(msgTemplate, args));
+    }
 }

src/main/java/com/fasterxml/jackson/databind/node/ArrayNode.java

@@ -126,6 +126,15 @@ public JsonNode path(int index) {
         return MissingNode.getInstance();
     }
 
+    @Override
+    public JsonNode required(int index) {
+        if ((index >= 0) && (index < _children.size())) {
+            return _children.get(index);
+        }
+        return _reportRequiredViolation("No value at index #%d [0, %d) of `ArrayNode`",
+                index, _children.size());
+    }
+
     @Override
     public boolean equals(Comparator<JsonNode> comparator, JsonNode o)
     {

src/main/java/com/fasterxml/jackson/databind/node/BaseJsonNode.java

@@ -64,6 +64,24 @@ public final JsonNode findPath(String fieldName)
     // Also, force (re)definition
     @Override public abstract int hashCode();
 
+    /*
+    /**********************************************************************
+    /* Improved required-ness checks for standard JsonNode implementations
+    /**********************************************************************
+     */
+
+    @Override
+    public JsonNode required(String fieldName) {
+        return _reportRequiredViolation("Node of type `%s` has no fields",
+                getClass().getSimpleName());
+    }
+
+    @Override
+    public JsonNode required(int index) {
+        return _reportRequiredViolation("Node of type `%s` has no indexed values",
+                getClass().getSimpleName());
+    }
+
     /*
     /**********************************************************
     /* Support for traversal-as-stream

src/main/java/com/fasterxml/jackson/databind/node/BigIntegerNode.java

@@ -19,9 +19,9 @@ public class BigIntegerNode
     private final static BigInteger MAX_INTEGER = BigInteger.valueOf(Integer.MAX_VALUE);
     private final static BigInteger MIN_LONG = BigInteger.valueOf(Long.MIN_VALUE);
     private final static BigInteger MAX_LONG = BigInteger.valueOf(Long.MAX_VALUE);
-    
+
     final protected BigInteger _value;
-    
+
     /*
     /**********************************************************
     /* Construction

src/main/java/com/fasterxml/jackson/databind/node/MissingNode.java

@@ -101,6 +101,18 @@ public boolean equals(Object o)
         return (o == this);
     }
 
+    @SuppressWarnings("unchecked")
+    @Override
+    public JsonNode require() {
+        return _reportRequiredViolation("require() called on `MissingNode`");
+    }
+
+    @SuppressWarnings("unchecked")
+    @Override
+    public JsonNode requireNonNull() {
+        return _reportRequiredViolation("requireNonNull() called on `MissingNode`");
+    }
+
     @Override
     public int hashCode() {
         return JsonNodeType.MISSING.ordinal();

src/main/java/com/fasterxml/jackson/databind/node/NullNode.java

@@ -3,6 +3,7 @@
 import java.io.IOException;
 
 import com.fasterxml.jackson.core.*;
+import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.SerializerProvider;
 
 
@@ -38,6 +39,12 @@ public JsonNodeType getNodeType() {
     @Override public String asText(String defaultValue) { return defaultValue; }
     @Override public String asText() { return "null"; }
 
+    @SuppressWarnings("unchecked")
+    @Override
+    public JsonNode requireNonNull() {
+        return _reportRequiredViolation("requireNonNull() called on `NullNode`");
+    }
+
     // as with MissingNode, not considered number node; hence defaults are returned if provided
 
     /*

src/main/java/com/fasterxml/jackson/databind/node/ObjectNode.java

@@ -126,6 +126,15 @@ public JsonNode path(String fieldName)
         return MissingNode.getInstance();
     }
 
+    @Override
+    public JsonNode required(String fieldName) {
+        JsonNode n = _children.get(fieldName);
+        if (n != null) {
+            return n;
+        }
+        return _reportRequiredViolation("No value for property '%s' of `ObjectNode`", fieldName);
+    }
+
     /**
      * Method to use for accessing all fields (with both names
      * and values) of this JSON Object.

src/test/java/com/fasterxml/jackson/databind/jsontype/deftyping/TestDefaultForObject.java

@@ -2,7 +2,6 @@
 
 import java.util.*;
 
-
 import com.fasterxml.jackson.core.*;
 import com.fasterxml.jackson.annotation.JsonTypeInfo;
 import com.fasterxml.jackson.databind.*;
@@ -381,16 +380,16 @@ public void testNoGoWithExternalProperty() throws Exception
     public void testWithFinalClass() throws Exception
     {
         // First: type info NOT included
-        ObjectMapper mapper = JsonMapper.builder()
+        ObjectMapper mapper = jsonMapperBuilder()
                 .activateDefaultTyping(NoCheckSubTypeValidator.instance,
-                        ObjectMapper.DefaultTyping.NON_FINAL)
+                        DefaultTyping.NON_FINAL)
                 .build();
         assertEquals(aposToQuotes("{'name':'abc'}"),
                 mapper.writeValueAsString(new FinalStringBean("abc")));
 
-        mapper = JsonMapper.builder()
+        mapper = jsonMapperBuilder()
                 .activateDefaultTyping(NoCheckSubTypeValidator.instance,
-                        ObjectMapper.DefaultTyping.EVERYTHING)
+                        DefaultTyping.EVERYTHING)
                 .build();
         assertEquals(aposToQuotes("['"+FinalStringBean.class.getName()+"',{'name':'abc'}]"),
                 mapper.writeValueAsString(new FinalStringBean("abc")));

src/test/java/com/fasterxml/jackson/databind/node/ObjectNodeTest.java

@@ -68,7 +68,7 @@ static class MyValue
     /**********************************************************
      */
 
-    private final ObjectMapper MAPPER = objectMapper();
+    private final ObjectMapper MAPPER = sharedMapper();
 
     public void testSimpleObject() throws Exception
     {