a comment added to explain the use of HashMap

ttulka · ttulka · commit d0f560799820 · 2017-06-08T08:03:14.000+02:00
to avoid misconception of contributors about using HashMap to implement
a JSON object as a unordered collection by the definition
diff --git a/JSONObject.java b/JSONObject.java
@@ -164,6 +164,7 @@ public String toString() {
      * Construct an empty JSONObject.
      */
     public JSONObject() {
+        // HashMap is used on purpose to ensure that elements are unordered
         this.map = new HashMap<String, Object>();
     }
 
@@ -216,15 +217,15 @@ public JSONObject(JSONTokener x) throws JSONException {
                 key = x.nextValue().toString();
             }
 
-// The key is followed by ':'.
+            // The key is followed by ':'.
 
             c = x.nextClean();
             if (c != ':') {
                 throw x.syntaxError("Expected a ':' after a key");
             }
             this.putOnce(key, x.nextValue());
 
-// Pairs are separated by ','.
+            // Pairs are separated by ','.
 
             switch (x.nextClean()) {
             case ';':
