Expose field comparison failures as a list in JSONCompareResult

hertzsprung · hertzsprung · commit ae02195ee4e8 · 2012-09-12T18:17:48.000+01:00
Add new bean, FieldComparisonFailure.  Deprecate field, expected and actual accessors.
diff --git a/src/main/java/org/skyscreamer/jsonassert/FieldComparisonFailure.java b/src/main/java/org/skyscreamer/jsonassert/FieldComparisonFailure.java
@@ -0,0 +1,28 @@
+package org.skyscreamer.jsonassert;
+
+/**
+ * Models a failure when comparing two fields.
+ */
+public class FieldComparisonFailure {
+    private final String _field;
+    private final Object _expected;
+    private final Object _actual;
+
+    public FieldComparisonFailure(String field, Object expected, Object actual) {
+        this._field = field;
+        this._expected = expected;
+        this._actual = actual;
+    }
+
+    public String getField() {
+        return _field;
+    }
+
+    public Object getExpected() {
+        return _expected;
+    }
+
+    public Object getActual() {
+        return _actual;
+    }
+}
diff --git a/src/main/java/org/skyscreamer/jsonassert/JSONCompareResult.java b/src/main/java/org/skyscreamer/jsonassert/JSONCompareResult.java
@@ -1,5 +1,9 @@
 package org.skyscreamer.jsonassert;
 
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
 /**
  * Bean for holding results from JSONCompare.
  */
@@ -9,6 +13,7 @@ public class JSONCompareResult {
     private String _field;
     private Object _expected;
     private Object _actual;
+    private final List<FieldComparisonFailure> _fieldFailures = new ArrayList<FieldComparisonFailure>();
 
     /**
      * Default constructor.
@@ -46,12 +51,20 @@ public String getMessage() {
         return _message;
     }
 
+    /**
+     * Get the list of failures on field comparisons
+     */
+    public List<FieldComparisonFailure> getFieldFailures() {
+        return Collections.unmodifiableList(_fieldFailures);
+    }
+
     /**
      * Actual field value
      * 
      * @return a {@code JSONObject}, {@code JSONArray} or other {@code Object}
      *         instance, or {@code null} if the comparison did not fail on a
      *         particular field
+     * @deprecated Superseded by {@link #getFieldFailures()}
      */
     public Object getActual() {
         return _actual;
@@ -63,23 +76,25 @@ public Object getActual() {
      * @return a {@code JSONObject}, {@code JSONArray} or other {@code Object}
      *         instance, or {@code null} if the comparison did not fail on a
      *         particular field
+     * @deprecated Superseded by {@link #getFieldFailures()}
      */
     public Object getExpected() {
         return _expected;
     }
     
     /**
-     * Check if comparison failed on a particular field
+     * Check if comparison failed on any particular fields
      */
     public boolean isFailureOnField() {
-        return _field != null;
+        return !_fieldFailures.isEmpty();
     }
 
     /**
      * Dot-separated path the the field that failed comparison
      * 
      * @return a {@code String} instance, or {@code null} if the comparison did
      *         not fail on a particular field
+     * @deprecated Superseded by {@link #getFieldFailures()}
      */
     public String getField() {
         return _field;
@@ -102,6 +117,7 @@ protected void fail(String message) {
      * @param actual Actual result
      */
     protected void fail(String field, Object expected, Object actual) {
+        _fieldFailures.add(new FieldComparisonFailure(field, expected, actual));
         this._field = field;
         this._expected = expected;
         this._actual = actual;
diff --git a/src/test/java/org/skyscreamer/jsonassert/JSONAssertTest.java b/src/test/java/org/skyscreamer/jsonassert/JSONAssertTest.java
@@ -1,5 +1,7 @@
 package org.skyscreamer.jsonassert;
 
+import java.util.Arrays;
+
 import org.json.JSONException;
 import org.junit.Assert;
 import org.junit.Test;
@@ -147,6 +149,11 @@ public void testFieldMismatch() throws JSONException {
         Assert.assertEquals("Pat", result.getExpected());
         Assert.assertEquals("Sue", result.getActual());
         Assert.assertEquals("name", result.getField());
+
+        FieldComparisonFailure comparisonFailure = result.getFieldFailures().iterator().next();
+        Assert.assertEquals("Pat", comparisonFailure.getExpected());
+        Assert.assertEquals("Sue", comparisonFailure.getActual());
+        Assert.assertEquals("name", comparisonFailure.getField());
     }
 
     @Test
