Restore and deprecate Customization matches

Duncan Mackinder · Duncan Mackinder · commit 7c096c6b1484 · 2014-02-02T11:10:34.000Z
Restore original Customization matches(Object actual, Object expected)
method, but mark it deprecated.  This method is normally only called
from CustomComparator compareValues method, which now calls the new
Customization matches(String prefix, Object actual, Object expected,
JSONCompareResult result) method.  Add JavaDoc to Customization matches
methods
diff --git a/src/main/java/org/skyscreamer/jsonassert/Customization.java b/src/main/java/org/skyscreamer/jsonassert/Customization.java
@@ -22,8 +22,47 @@ public boolean appliesToPath(String path) {
         return this.path.equals(path);
     }
 
+	/**
+	 * Return true if actual value matches expected value using this
+	 * Customization's comparator. Calls to this method should be replaced by
+	 * calls to matches(String prefix, Object actual, Object expected,
+	 * JSONCompareResult result).
+	 * 
+	 * @param actual
+	 *            JSON value being tested
+	 * @param expected
+	 *            expected JSON value
+	 * @return true if actual value matches expected value
+	 */
+    @Deprecated
+    public boolean matches(Object actual, Object expected) {
+        return comparator.equal(actual, expected);
+    }
+    
+	/**
+	 * Return true if actual value matches expected value using this
+	 * Customization's comparator. The equal method used for comparison depends
+	 * on type of comparator.
+	 * 
+	 * @param prefix
+	 *            JSON path of the JSON item being tested (only used if
+	 *            comparator is a LocationAwareValueMatcher)
+	 * @param actual
+	 *            JSON value being tested
+	 * @param expected
+	 *            expected JSON value
+	 * @param result
+	 *            JSONCompareResult to which match failure may be passed (only
+	 *            used if comparator is a LocationAwareValueMatcher)
+	 * @return true if expected and actual equal or any difference has already
+	 *         been passed to specified result instance, false otherwise.
+	 * @throws ValueMatcherException
+	 *             if expected and actual values not equal and ValueMatcher
+	 *             needs to override default comparison failure message that
+	 *             would be generated if this method returned false.
+	 */
 	public boolean matches(String prefix, Object actual, Object expected,
-			JSONCompareResult result) {
+			JSONCompareResult result) throws ValueMatcherException {
 		if (comparator instanceof LocationAwareValueMatcher) {
 			return ((LocationAwareValueMatcher<Object>)comparator).equal(prefix, actual, expected, result);
 		}
