Merge pull request skyscreamer#11 from carterpage/master

carterpage · carterpage · commit c114fc19f470 · 2012-09-03T12:10:15.000-07:00
Add changelog
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,15 @@
+Changelog
+=========
+
+Version 1.0.1 - 9/3/2012
+------------------------
+ - Added withStrictOrdering() and withExtensible() to JSONCompareMode
+ - Javadoc fixes
+ - Fix bug where expected and actual were reversed
+ - Fix bug where nulls gave false positives in some cases
+ - Simplified publishing Javadocs
+
+Version 1.0.0 - 4/5/2012
+------------------------
+Initial release!
+
diff --git a/src/main/java/org/skyscreamer/jsonassert/JSONAssert.java b/src/main/java/org/skyscreamer/jsonassert/JSONAssert.java
@@ -38,6 +38,8 @@
  *
  */
 public class JSONAssert {
+    private JSONAssert() {}
+
     /**
      * Asserts that the JSONObject provided matches the expected string.  If it isn't it throws an
      * {@link AssertionError}.
diff --git a/src/main/java/org/skyscreamer/jsonassert/JSONCompare.java b/src/main/java/org/skyscreamer/jsonassert/JSONCompare.java
@@ -13,6 +13,8 @@
  * non-JUnit test framework)
  */
 public class JSONCompare {
+    private JSONCompare() {}
+
     /**
      * Compares JSON string provided to the expected JSON string, and returns the results of the comparison.
      *
diff --git a/src/main/java/org/skyscreamer/jsonassert/JSONCompareResult.java b/src/main/java/org/skyscreamer/jsonassert/JSONCompareResult.java
@@ -95,6 +95,12 @@ protected void fail(String message) {
         }
     }
 
+    /**
+     * Identify that the comparison failed
+     * @param field Which field failed
+     * @param expected Expected result
+     * @param actual Actual result
+     */
     protected void fail(String field, Object expected, Object actual) {
         this._field = field;
         this._expected = expected;
diff --git a/src/main/java/org/skyscreamer/jsonassert/JSONParser.java b/src/main/java/org/skyscreamer/jsonassert/JSONParser.java
@@ -8,6 +8,8 @@
  * Simple JSON parsing utility.
  */
 public class JSONParser {
+    private JSONParser() {}
+
     /**
      * Takes a JSON string and returns either a {@link org.json.JSONObject} or {@link org.json.JSONArray},
      * depending on whether the string represents an object or an array.

Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,8 @@`
`38`	`38`	`*`
`39`	`39`	`*/`
`40`	`40`	`public class JSONAssert {`
	`41`	`+ private JSONAssert() {}`
	`42`	`+`
`41`	`43`	`/**`
`42`	`44`	`* Asserts that the JSONObject provided matches the expected string. If it isn't it throws an`
`43`	`45`	`* {@link AssertionError}.`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,8 @@`
`13`	`13`	`* non-JUnit test framework)`
`14`	`14`	`*/`
`15`	`15`	`public class JSONCompare {`
	`16`	`+ private JSONCompare() {}`
	`17`	`+`
`16`	`18`	`/**`
`17`	`19`	`* Compares JSON string provided to the expected JSON string, and returns the results of the comparison.`
`18`	`20`	`*`
Original file line number	Diff line number	Diff line change
`@@ -95,6 +95,12 @@ protected void fail(String message) {`
`95`	`95`	`}`
`96`	`96`	`}`
`97`	`97`
	`98`	`+ /**`
	`99`	`+ * Identify that the comparison failed`
	`100`	`+ * @param field Which field failed`
	`101`	`+ * @param expected Expected result`
	`102`	`+ * @param actual Actual result`
	`103`	`+ */`
`98`	`104`	`protected void fail(String field, Object expected, Object actual) {`
`99`	`105`	`this._field = field;`
`100`	`106`	`this._expected = expected;`