issue-232: Add method for getting full description from diff

Boiarshinov · Boiarshinov · commit 6d2bf0da6f8b · 2021-10-04T09:17:57.000+03:00
diff --git a/xmlunit-core/src/main/java/org/xmlunit/diff/Diff.java b/xmlunit-core/src/main/java/org/xmlunit/diff/Diff.java
@@ -15,6 +15,7 @@
 package org.xmlunit.diff;
 
 import javax.xml.transform.Source;
+import java.util.Iterator;
 
 /**
  * The Diff-Object is the result of two comparisons.
@@ -48,6 +49,38 @@ public Diff(Source controlSource, Source testSource,
         }
     }
 
+    /**
+     * Returns a string representation of this diff
+     * using internal {@link ComparisonFormatter} or
+     * {@link DefaultComparisonFormatter} if formatter wasn't set.
+     * Each comparison result separated by the end of the line.
+     * @return a string representation of this diff
+     */
+    public String fullDescription() {
+        return fullDescription(formatter);
+    }
+
+    /**
+     * Returns a string representation of this diff
+     * using the given {@link ComparisonFormatter}
+     * @param formatter the {@link ComparisonFormatter} to use
+     * @return a string representation of this diff
+     */
+    public String fullDescription(ComparisonFormatter formatter) {
+        if (!hasDifferences()) {
+            return "[identical]";
+        }
+        Iterator<Difference> diffIterator = getDifferences().iterator();
+        StringBuilder result = new StringBuilder()
+            .append(diffIterator.next().getComparison().toString(formatter));
+        String lineSeparator = System.lineSeparator();
+        while (diffIterator.hasNext()) {
+            result.append(lineSeparator)
+                .append(diffIterator.next().getComparison().toString(formatter));
+        }
+        return result.toString();
+    }
+
     /**
      * @return true if there was at least one difference.
      */
@@ -72,11 +105,25 @@ public Source getTestSource() {
         return testSource;
     }
 
+    /**
+     * Returns a string representation of first found difference in this diff
+     * using internal {@link ComparisonFormatter} or
+     * {@link DefaultComparisonFormatter} if formatter wasn't set
+     * @return a string representation of first found difference in this diff
+     * @see #fullDescription()
+     */
     @Override
     public String toString() {
         return toString(formatter);
     }
 
+    /**
+     * Returns a string representation of first found difference in this diff
+     * using the given {@link ComparisonFormatter}
+     * @param formatter the {@link ComparisonFormatter} to use
+     * @return a string representation of first found difference in this diff
+     * @see #fullDescription(ComparisonFormatter)
+     */
     public String toString(ComparisonFormatter formatter) {
         if (!hasDifferences()) {
             return "[identical]";
