mirror of
https://github.com/stleary/JSON-java.git
synced 2025-08-03 11:25:30 -04:00
Adding comments
This commit is contained in:
parent
ffd48afa42
commit
7701f21839
@ -152,11 +152,29 @@ public class JSONArray implements Iterable<Object> {
|
|||||||
this(collection, 0, new JSONParserConfiguration());
|
this(collection, 0, new JSONParserConfiguration());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Construct a JSONArray from a Collection.
|
||||||
|
*
|
||||||
|
* @param collection
|
||||||
|
* A Collection.
|
||||||
|
* @param jsonParserConfiguration
|
||||||
|
* Configuration object for the JSON parser
|
||||||
|
*/
|
||||||
public JSONArray(Collection<?> collection, JSONParserConfiguration jsonParserConfiguration) {
|
public JSONArray(Collection<?> collection, JSONParserConfiguration jsonParserConfiguration) {
|
||||||
this(collection, 0, jsonParserConfiguration);
|
this(collection, 0, jsonParserConfiguration);
|
||||||
}
|
}
|
||||||
|
|
||||||
protected JSONArray(Collection<?> collection, int recursionDepth, JSONParserConfiguration jsonParserConfiguration) {
|
/**
|
||||||
|
* Construct a JSONArray from a collection with recursion depth.
|
||||||
|
*
|
||||||
|
* @param collection
|
||||||
|
* A Collection.
|
||||||
|
* @param recursionDepth
|
||||||
|
* Variable for tracking the count of nested object creations.
|
||||||
|
* @param jsonParserConfiguration
|
||||||
|
* Configuration object for the JSON parser
|
||||||
|
*/
|
||||||
|
JSONArray(Collection<?> collection, int recursionDepth, JSONParserConfiguration jsonParserConfiguration) {
|
||||||
if (recursionDepth > jsonParserConfiguration.getMaxNestingDepth()) {
|
if (recursionDepth > jsonParserConfiguration.getMaxNestingDepth()) {
|
||||||
throw new JSONException("JSONArray has reached recursion depth limit of " + jsonParserConfiguration.getMaxNestingDepth());
|
throw new JSONException("JSONArray has reached recursion depth limit of " + jsonParserConfiguration.getMaxNestingDepth());
|
||||||
}
|
}
|
||||||
@ -1362,7 +1380,7 @@ public class JSONArray implements Iterable<Object> {
|
|||||||
* @param value
|
* @param value
|
||||||
* The Map value.
|
* The Map value.
|
||||||
* @param jsonParserConfiguration
|
* @param jsonParserConfiguration
|
||||||
* Configuration for recursive depth
|
* Configuration object for the JSON parser
|
||||||
* @return
|
* @return
|
||||||
* @throws JSONException
|
* @throws JSONException
|
||||||
* If the index is negative or if the value is an invalid
|
* If the index is negative or if the value is an invalid
|
||||||
@ -1811,8 +1829,7 @@ public class JSONArray implements Iterable<Object> {
|
|||||||
* {@code true} to call {@link JSONObject#wrap(Object)} for each item,
|
* {@code true} to call {@link JSONObject#wrap(Object)} for each item,
|
||||||
* {@code false} to add the items directly
|
* {@code false} to add the items directly
|
||||||
* @param recursionDepth
|
* @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) {
|
private void addAll(Collection<?> collection, boolean wrap, int recursionDepth, JSONParserConfiguration jsonParserConfiguration) {
|
||||||
this.myArrayList.ensureCapacity(this.myArrayList.size() + collection.size());
|
this.myArrayList.ensureCapacity(this.myArrayList.size() + collection.size());
|
||||||
@ -1852,8 +1869,14 @@ public class JSONArray implements Iterable<Object> {
|
|||||||
* Add an array's elements to the JSONArray.
|
* Add an array's elements to the JSONArray.
|
||||||
*
|
*
|
||||||
* @param array
|
* @param array
|
||||||
|
* Array. If the parameter passed is null, or not an array,
|
||||||
|
* JSONArray, Collection, or Iterable, an exception will be
|
||||||
|
* thrown.
|
||||||
* @param wrap
|
* @param wrap
|
||||||
|
* {@code true} to call {@link JSONObject#wrap(Object)} for each item,
|
||||||
|
* {@code false} to add the items directly
|
||||||
* @throws JSONException
|
* @throws JSONException
|
||||||
|
* If not an array or if an array value is non-finite number.
|
||||||
*/
|
*/
|
||||||
private void addAll(Object array, boolean wrap) throws JSONException {
|
private void addAll(Object array, boolean wrap) throws JSONException {
|
||||||
this.addAll(array, wrap, 0);
|
this.addAll(array, wrap, 0);
|
||||||
@ -1867,7 +1890,10 @@ public class JSONArray implements Iterable<Object> {
|
|||||||
* JSONArray, Collection, or Iterable, an exception will be
|
* JSONArray, Collection, or Iterable, an exception will be
|
||||||
* thrown.
|
* thrown.
|
||||||
* @param wrap
|
* @param wrap
|
||||||
|
* {@code true} to call {@link JSONObject#wrap(Object)} for each item,
|
||||||
|
* {@code false} to add the items directly
|
||||||
* @param recursionDepth
|
* @param recursionDepth
|
||||||
|
* Variable for tracking the count of nested object creations.
|
||||||
*/
|
*/
|
||||||
private void addAll(Object array, boolean wrap, int recursionDepth) {
|
private void addAll(Object array, boolean wrap, int recursionDepth) {
|
||||||
addAll(array, wrap, recursionDepth, new JSONParserConfiguration());
|
addAll(array, wrap, recursionDepth, new JSONParserConfiguration());
|
||||||
@ -1883,8 +1909,8 @@ public class JSONArray implements Iterable<Object> {
|
|||||||
* {@code true} to call {@link JSONObject#wrap(Object)} for each item,
|
* {@code true} to call {@link JSONObject#wrap(Object)} for each item,
|
||||||
* {@code false} to add the items directly
|
* {@code false} to add the items directly
|
||||||
* @param recursionDepth
|
* @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 recursionDepth
|
* @param jsonParserConfiguration
|
||||||
* Variable to pass parser custom configuration for json parsing.
|
* Variable to pass parser custom configuration for json parsing.
|
||||||
* @throws JSONException
|
* @throws JSONException
|
||||||
* If not an array or if an array value is non-finite number.
|
* If not an array or if an array value is non-finite number.
|
||||||
|
@ -279,6 +279,15 @@ public class JSONObject {
|
|||||||
this(m, 0, new JSONParserConfiguration());
|
this(m, 0, new JSONParserConfiguration());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Construct a JSONObject from a Map with custom json parse configurations.
|
||||||
|
*
|
||||||
|
* @param m
|
||||||
|
* A map object that can be used to initialize the contents of
|
||||||
|
* the JSONObject.
|
||||||
|
* @param jsonParserConfiguration
|
||||||
|
* Variable to pass parser custom configuration for json parsing.
|
||||||
|
*/
|
||||||
public JSONObject(Map<?, ?> m, JSONParserConfiguration jsonParserConfiguration) {
|
public JSONObject(Map<?, ?> m, JSONParserConfiguration jsonParserConfiguration) {
|
||||||
this(m, 0, jsonParserConfiguration);
|
this(m, 0, jsonParserConfiguration);
|
||||||
}
|
}
|
||||||
@ -287,7 +296,7 @@ public class JSONObject {
|
|||||||
* Construct a JSONObject from a map with recursion depth.
|
* Construct a JSONObject from a map with recursion depth.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
protected JSONObject(Map<?, ?> m, int recursionDepth, JSONParserConfiguration jsonParserConfiguration) {
|
private JSONObject(Map<?, ?> m, int recursionDepth, JSONParserConfiguration jsonParserConfiguration) {
|
||||||
if (recursionDepth > jsonParserConfiguration.getMaxNestingDepth()) {
|
if (recursionDepth > jsonParserConfiguration.getMaxNestingDepth()) {
|
||||||
throw new JSONException("JSONObject has reached recursion depth limit of " + jsonParserConfiguration.getMaxNestingDepth());
|
throw new JSONException("JSONObject has reached recursion depth limit of " + jsonParserConfiguration.getMaxNestingDepth());
|
||||||
}
|
}
|
||||||
@ -2581,7 +2590,23 @@ public class JSONObject {
|
|||||||
return wrap(object, null);
|
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);
|
return wrap(object, null, recursionDepth, jsonParserConfiguration);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user