Adding comments

stleary · Dec 24, 2023 · fa8ad5d · fa8ad5d
1 parent a73302e
commit fa8ad5d
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 6 deletions.
diff --git a/src/main/java/org/json/JSONArray.java b/src/main/java/org/json/JSONArray.java
@@ -170,7 +170,7 @@ public JSONArray(Collection<?> collection, JSONParserConfiguration jsonParserCon
      * @param collection
      *             A Collection.
      * @param recursionDepth
-     *             variable to keep the count of how nested the object creation is happening.
+     *             Variable for tracking the count of nested object creations.
      * @param jsonParserConfiguration
      *             Configuration object for the JSON parser
      */
@@ -1829,8 +1829,7 @@ public boolean isEmpty() {
      *            {@code true} to call {@link JSONObject#wrap(Object)} for each item,
      *            {@code false} to add the items directly
      * @param recursionDepth
-     *            variable to keep the count of how nested the object creation is happening.
-     *            
+     *            Variable for tracking the count of nested object creations.
      */
     private void addAll(Collection<?> collection, boolean wrap, int recursionDepth, JSONParserConfiguration jsonParserConfiguration) {
         this.myArrayList.ensureCapacity(this.myArrayList.size() + collection.size());
@@ -1894,7 +1893,7 @@ private void addAll(Object array, boolean wrap) throws JSONException {
      *          {@code true} to call {@link JSONObject#wrap(Object)} for each item,
      *          {@code false} to add the items directly
      * @param recursionDepth
-     *          variable to keep the count of how nested the object creation is happening.
+     *          Variable for tracking the count of nested object creations.
      */
     private void addAll(Object array, boolean wrap, int recursionDepth) {
         addAll(array, wrap, recursionDepth, new JSONParserConfiguration());
@@ -1910,7 +1909,7 @@ private void addAll(Object array, boolean wrap, int recursionDepth) {
      *            {@code true} to call {@link JSONObject#wrap(Object)} for each item,
      *            {@code false} to add the items directly
      * @param recursionDepth
-     *            Variable to keep the count of how nested the object creation is happening.
+     *            Variable for tracking the count of nested object creations.
      * @param jsonParserConfiguration
      *            Variable to pass parser custom configuration for json parsing.
      * @throws JSONException

diff --git a/src/main/java/org/json/JSONObject.java b/src/main/java/org/json/JSONObject.java
@@ -2590,7 +2590,23 @@ public static Object wrap(Object object) {
         return wrap(object, null);
     }
 
-    public static Object wrap(Object object, int recursionDepth, JSONParserConfiguration jsonParserConfiguration) {
+    /**
+     * Wrap an object, if necessary. If the object is <code>null</code>, return the NULL
+     * object. If it is an array or collection, wrap it in a JSONArray. If it is
+     * a map, wrap it in a JSONObject. If it is a standard property (Double,
+     * String, et al) then it is already wrapped. Otherwise, if it comes from
+     * one of the java packages, turn it into a string. And if it doesn't, try
+     * to wrap it in a JSONObject. If the wrapping fails, then null is returned.
+     *
+     * @param object
+     *            The object to wrap
+     * @param recursionDepth
+     *            Variable for tracking the count of nested object creations.
+     * @param jsonParserConfiguration
+     *            Variable to pass parser custom configuration for json parsing.
+     * @return The wrapped value
+     */
+    static Object wrap(Object object, int recursionDepth, JSONParserConfiguration jsonParserConfiguration) {
       return wrap(object, null, recursionDepth, jsonParserConfiguration);
     }