java.lang.Object
- org.json.JSONObject

```
public class JSONObject
extends java.lang.Object
```
A JSONObject is an unordered collection of name/value pairs. Its external form is a string wrapped in curly braces with colons between the names and values, and commas between the values and names. The internal form is an object having get and opt methods for accessing the values by name, and put methods for adding or replacing values by name. The values can be any of these types: Boolean, JSONArray, JSONObject, Number, String, or the JSONObject.NULL object. A JSONObject constructor can be used to convert an external form JSON text into an internal form whose values can be retrieved with the get and opt methods, or to convert values into a JSON text using the put and toString methods. A get method returns a value if one can be found, and throws an exception if one cannot be found. An opt method returns a default value instead of throwing an exception, and so is useful for obtaining optional values.
The generic get() and opt() methods return an object, which you can cast or query for type. There are also typed get and opt methods that do type checking and type coercion for you. The opt methods differ from the get methods in that they do not throw. Instead, they return a specified value, such as null.
The put methods add or replace values in an object. For example,
```
 myString = new JSONObject()
         .put("JSON", "Hello, World!").toString();
 
```
produces the string {"JSON": "Hello, World"}.
The texts produced by the toString methods strictly conform to the JSON syntax rules. The constructors are more forgiving in the texts they will accept:
- An extra , (comma) may appear just before the closing brace.
- Strings may be quoted with ' (single quote).
- Strings do not need to be quoted at all if they do not begin with a quote or single quote, and if they do not contain leading or trailing spaces, and if they do not contain any of these characters: { } [ ] / \ : , # and if they do not look like numbers and if they are not the reserved words true, false, or null.
Version:

2016-08-15

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`private static class`	`JSONObject.Null`	JSONObject.NULL is equivalent to the value that JavaScript calls null, whilst Java's null is equivalent to the value that JavaScript calls undefined.

Field Summary

Fields
Modifier and Type	Field	Description
`private static java.util.Set<java.lang.String>`	`EXCLUDED_RECORD_METHOD_NAMES`	Set of method names that should be excluded when identifying record-style accessors.
`private java.util.Map<java.lang.String,java.lang.Object>`	`map`	The map where the JSONObject's properties are kept.
`static java.lang.Object`	`NULL`	It is sometimes more convenient and less ambiguous to have a `NULL` object than to use Java's `null` value.
`(package private) static java.util.regex.Pattern`	`NUMBER_PATTERN`	Regular Expression Pattern that matches JSON Numbers.

Constructor Summary

Constructors
Modifier	Constructor	Description
	`JSONObject()`	Construct an empty JSONObject.
`protected`	`JSONObject(int initialCapacity)`	Constructor to specify an initial capacity of the internal map.
	`JSONObject(java.lang.Object bean)`	Construct a JSONObject from an Object using bean getters.
	`JSONObject(java.lang.Object object, java.lang.String... names)`	Construct a JSONObject from an Object, using reflection to find the public members.
`private`	`JSONObject(java.lang.Object bean, java.util.Set<java.lang.Object> objectsRecord)`
	`JSONObject(java.lang.Object bean, JSONParserConfiguration jsonParserConfiguration)`
	`JSONObject(java.lang.String source)`	Construct a JSONObject from a source JSON text string.
	`JSONObject(java.lang.String baseName, java.util.Locale locale)`	Construct a JSONObject from a ResourceBundle.
	`JSONObject(java.lang.String source, JSONParserConfiguration jsonParserConfiguration)`	Construct a JSONObject from a source JSON text string with custom json parse configurations.
	`JSONObject(java.util.Map<?,?> m)`	Construct a JSONObject from a Map.
`private`	`JSONObject(java.util.Map<?,?> m, int recursionDepth, JSONParserConfiguration jsonParserConfiguration)`	Construct a JSONObject from a map with recursion depth.
	`JSONObject(java.util.Map<?,?> m, JSONParserConfiguration jsonParserConfiguration)`	Construct a JSONObject from a Map with custom json parse configurations.
	`JSONObject(JSONObject jo, java.lang.String... names)`	Construct a JSONObject from a subset of another JSONObject.
	`JSONObject(JSONTokener x)`	Construct a JSONObject from a JSONTokener.
	`JSONObject(JSONTokener x, JSONParserConfiguration jsonParserConfiguration)`	Construct a JSONObject from a JSONTokener with custom json parse configurations.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`JSONObject`	`accumulate(java.lang.String key, java.lang.Object value)`	Accumulate values under a key.
`private static boolean`	`annotationValueNotEmpty(JSONPropertyName annotation)`	checks if the annotation is not null and the `JSONPropertyName.value()` is not null and is not empty.
`JSONObject`	`append(java.lang.String key, java.lang.Object value)`	Append values to the array under a key.
`private static java.math.BigInteger`	`attemptConversionToBigInteger(java.lang.Object val, java.math.BigInteger defaultValue, int maxNumberLength)`	Convenience method to attempt conversion of value to BigInteger.
`private static void`	`attemptWriteValue(java.io.Writer writer, int indentFactor, int indent, java.util.Map.Entry<java.lang.String,?> entry, java.lang.String key)`	Convenience function.
`private static void`	`checkForInvalidNumberFormat(java.lang.String val, char initial)`	Convenience function.
`private static void`	`checkKeyForStrictMode(JSONTokener jsonTokener, JSONParserConfiguration jsonParserConfiguration, java.lang.Object obj)`	Throws error if key violates strictMode
`private boolean`	`checkObjectType(java.lang.Object valueThis, java.lang.Object valueOther)`	Convenience function.
`private boolean`	`checkSimilarEntries(java.lang.Object other)`
`void`	`clear()`	Removes all of the elements from this JSONObject.
`private static void`	`closeClosable(java.lang.Object input)`	calls `Closeable.close()` on the input, if it is an instance of Closable.
`private java.util.Map<?,?>`	`convertToMap(JSONObject jsonMap, java.lang.reflect.Type keyType, java.lang.reflect.Type valueType, java.lang.Class<?> mapType)`	Converts a JSONObject to a Map with the specified generic key and value Types.
`private java.lang.Object`	`convertValue(java.lang.Object value, java.lang.reflect.Type targetType)`	Recursively converts a value to the target Type, handling nested generics for Collections and Maps.
`static java.lang.String`	`doubleToString(double d)`	Produce a string from a double.
`protected java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>>`	`entrySet()`	Get a set of entries of the JSONObject.
`<T> T`	`fromJson(java.lang.Class<T> clazz)`	Deserializes a JSON string into an instance of the specified class.
`static <T> T`	`fromJson(java.lang.String jsonString, java.lang.Class<T> clazz)`	Deserializes a JSON string into an instance of the specified class.
`private <T> java.util.Collection<T>`	`fromJsonArray(JSONArray jsonArray, java.lang.Class<?> collectionType, java.lang.reflect.Type elementType)`	Deserializes a JSONArray into a Collection, supporting nested generics.
`java.lang.Object`	`get(java.lang.String key)`	Get the value object associated with a key.
`private static <A extends java.lang.annotation.Annotation> A`	`getAnnotation(java.lang.reflect.Method m, java.lang.Class<A> annotationClass)`	Searches the class hierarchy to see if the method or it's super implementations and interfaces has the annotation.
`private static int`	`getAnnotationDepth(java.lang.reflect.Method m, java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass)`	Searches the class hierarchy to see if the method or it's super implementations and interfaces has the annotation.
`java.math.BigDecimal`	`getBigDecimal(java.lang.String key)`	Get the BigDecimal value associated with a key.
`java.math.BigInteger`	`getBigInteger(java.lang.String key)`	Get the BigInteger value associated with a key.
`java.math.BigInteger`	`getBigInteger(java.lang.String key, JSONParserConfiguration jsonParserConfiguration)`	Get the BigInteger value associated with a key.
`boolean`	`getBoolean(java.lang.String key)`	Get the boolean value associated with a key.
`private java.util.Collection`	`getCollection(java.lang.Class<?> collectionType)`	Creates and returns a new instance of a supported `Collection` implementation based on the specified collection type.
`double`	`getDouble(java.lang.String key)`	Get the double value associated with a key.
`private java.lang.reflect.Type`	`getElementType(java.lang.reflect.Type type)`	Extracts the element Type for a Collection Type.
`<E extends java.lang.Enum<E>> E`	`getEnum(java.lang.Class<E> clazz, java.lang.String key)`	Get the enum value associated with a key.
`float`	`getFloat(java.lang.String key)`	Get the float value associated with a key.
`int`	`getInt(java.lang.String key)`	Get the int value associated with a key.
`JSONArray`	`getJSONArray(java.lang.String key)`	Get the JSONArray value associated with a key.
`JSONObject`	`getJSONObject(java.lang.String key)`	Get the JSONObject value associated with a key.
`private static java.lang.String`	`getKeyNameFromMethod(java.lang.reflect.Method method, boolean isRecordType)`
`long`	`getLong(java.lang.String key)`	Get the long value associated with a key.
`java.lang.Class<? extends java.util.Map>`	`getMapType()`	Retrieves the type of the underlying Map in this class.
`private java.lang.reflect.Type[]`	`getMapTypes(java.lang.reflect.Type type)`	Extracts the key and value Types for a Map Type.
`private static java.lang.reflect.Method[]`	`getMethods(java.lang.Class<?> klass)`	This is a convenience method to simplify populate maps
`static java.lang.String[]`	`getNames(java.lang.Object object)`	Get an array of public field names from an Object.
`static java.lang.String[]`	`getNames(JSONObject jo)`	Get an array of field names from a JSONObject.
`java.lang.Number`	`getNumber(java.lang.String key)`	Get the Number value associated with a key.
`private static java.lang.Number`	`getNumber(java.lang.String val, char initial)`	Convenience function.
`private java.lang.Class<?>`	`getRawType(java.lang.reflect.Type type)`	Helper method to extract the raw Class from Type.
`java.lang.String`	`getString(java.lang.String key)`	Get the string associated with a key.
`boolean`	`has(java.lang.String key)`	Determine if the JSONObject contains a specific key.
`JSONObject`	`increment(java.lang.String key)`	Increment a property of a JSONObject.
`(package private) static void`	`indent(java.io.Writer writer, int indent)`
`protected static boolean`	`isDecimalNotation(java.lang.String val)`	Tests if the value should be tried as a decimal.
`boolean`	`isEmpty()`	Check if JSONObject is empty.
`boolean`	`isNull(java.lang.String key)`	Determine if the value associated with the key is `null` or if there is no value.
`(package private) static boolean`	`isNumberSimilar(java.lang.Number l, java.lang.Number r)`	Compares two numbers to see if they are similar.
`private static boolean`	`isRecordStyleAccessor(java.lang.String methodName, java.lang.reflect.Method method)`	Checks if a method is a record-style accessor.
`private static boolean`	`isRecordType(java.lang.Class<?> klass)`	Checks if a class is a Java record type.
`private static boolean`	`isValidMethod(java.lang.reflect.Method method)`	Checks if the method is valid for the `populateMap(Object, Set, JSONParserConfiguration)` use case
`private static boolean`	`isValidMethodName(java.lang.String name)`
`java.util.Iterator<java.lang.String>`	`keys()`	Get an enumeration of the keys of the JSONObject.
`java.util.Set<java.lang.String>`	`keySet()`	Get a set of keys of the JSONObject.
`int`	`length()`	Get the number of keys stored in the JSONObject.
`JSONArray`	`names()`	Produce a JSONArray containing the names of the elements of this JSONObject.
`private static boolean`	`numberIsFinite(java.lang.Number n)`
`static java.lang.String`	`numberToString(java.lang.Number number)`	Produce a string from a Number.
`(package private) static java.math.BigDecimal`	`objectToBigDecimal(java.lang.Object val, java.math.BigDecimal defaultValue)`
`(package private) static java.math.BigDecimal`	`objectToBigDecimal(java.lang.Object val, java.math.BigDecimal defaultValue, boolean exact)`
`(package private) static java.math.BigInteger`	`objectToBigInteger(java.lang.Object val, java.math.BigInteger defaultValue)`
`(package private) static java.math.BigInteger`	`objectToBigInteger(java.lang.Object val, java.math.BigInteger defaultValue, JSONParserConfiguration jsonParserConfiguration)`
`java.lang.Object`	`opt(java.lang.String key)`	Get an optional value associated with a key.
`java.math.BigDecimal`	`optBigDecimal(java.lang.String key, java.math.BigDecimal defaultValue)`	Get an optional BigDecimal associated with a key, or the defaultValue if there is no such key or if its value is not a number.
`java.math.BigInteger`	`optBigInteger(java.lang.String key, java.math.BigInteger defaultValue)`	Get an optional BigInteger associated with a key, or the defaultValue if there is no such key or if its value is not a number.
`java.math.BigInteger`	`optBigInteger(java.lang.String key, java.math.BigInteger defaultValue, JSONParserConfiguration jsonParserConfiguration)`	Get an optional BigInteger associated with a key, or the defaultValue if there is no such key or if its value is not a number.
`boolean`	`optBoolean(java.lang.String key)`	Get an optional boolean associated with a key.
`boolean`	`optBoolean(java.lang.String key, boolean defaultValue)`	Get an optional boolean associated with a key.
`java.lang.Boolean`	`optBooleanObject(java.lang.String key)`	Get an optional boolean object associated with a key.
`java.lang.Boolean`	`optBooleanObject(java.lang.String key, java.lang.Boolean defaultValue)`	Get an optional boolean object associated with a key.
`double`	`optDouble(java.lang.String key)`	Get an optional double associated with a key, or NaN if there is no such key or if its value is not a number.
`double`	`optDouble(java.lang.String key, double defaultValue)`	Get an optional double associated with a key, or the defaultValue if there is no such key or if its value is not a number.
`java.lang.Double`	`optDoubleObject(java.lang.String key)`	Get an optional Double object associated with a key, or NaN if there is no such key or if its value is not a number.
`java.lang.Double`	`optDoubleObject(java.lang.String key, java.lang.Double defaultValue)`	Get an optional Double object associated with a key, or the defaultValue if there is no such key or if its value is not a number.
`<E extends java.lang.Enum<E>> E`	`optEnum(java.lang.Class<E> clazz, java.lang.String key)`	Get the enum value associated with a key.
`<E extends java.lang.Enum<E>> E`	`optEnum(java.lang.Class<E> clazz, java.lang.String key, E defaultValue)`	Get the enum value associated with a key.
`float`	`optFloat(java.lang.String key)`	Get the optional float value associated with an index.
`float`	`optFloat(java.lang.String key, float defaultValue)`	Get the optional float value associated with an index.
`java.lang.Float`	`optFloatObject(java.lang.String key)`	Get the optional Float object associated with an index.
`java.lang.Float`	`optFloatObject(java.lang.String key, java.lang.Float defaultValue)`	Get the optional Float object associated with an index.
`int`	`optInt(java.lang.String key)`	Get an optional int value associated with a key, or zero if there is no such key or if the value is not a number.
`int`	`optInt(java.lang.String key, int defaultValue)`	Get an optional int value associated with a key, or the default if there is no such key or if the value is not a number.
`java.lang.Integer`	`optIntegerObject(java.lang.String key)`	Get an optional Integer object associated with a key, or zero if there is no such key or if the value is not a number.
`java.lang.Integer`	`optIntegerObject(java.lang.String key, java.lang.Integer defaultValue)`	Get an optional Integer object associated with a key, or the default if there is no such key or if the value is not a number.
`JSONArray`	`optJSONArray(java.lang.String key)`	Get an optional JSONArray associated with a key.
`JSONArray`	`optJSONArray(java.lang.String key, JSONArray defaultValue)`	Get an optional JSONArray associated with a key, or the default if there is no such key, or if its value is not a JSONArray.
`JSONObject`	`optJSONObject(java.lang.String key)`	Get an optional JSONObject associated with a key.
`JSONObject`	`optJSONObject(java.lang.String key, JSONObject defaultValue)`	Get an optional JSONObject associated with a key, or the default if there is no such key or if the value is not a JSONObject.
`long`	`optLong(java.lang.String key)`	Get an optional long value associated with a key, or zero if there is no such key or if the value is not a number.
`long`	`optLong(java.lang.String key, long defaultValue)`	Get an optional long value associated with a key, or the default if there is no such key or if the value is not a number.
`java.lang.Long`	`optLongObject(java.lang.String key)`	Get an optional Long object associated with a key, or zero if there is no such key or if the value is not a number.
`java.lang.Long`	`optLongObject(java.lang.String key, java.lang.Long defaultValue)`	Get an optional Long object associated with a key, or the default if there is no such key or if the value is not a number.
`java.lang.Number`	`optNumber(java.lang.String key)`	Get an optional `Number` value associated with a key, or `null` if there is no such key or if the value is not a number.
`java.lang.Number`	`optNumber(java.lang.String key, java.lang.Number defaultValue)`	Get an optional `Number` value associated with a key, or the default if there is no such key or if the value is not a number.
`java.lang.Object`	`optQuery(java.lang.String jsonPointer)`	Queries and returns a value from this object using `jsonPointer`, or returns null if the query fails due to a missing key.
`java.lang.Object`	`optQuery(JSONPointer jsonPointer)`	Queries and returns a value from this object using `jsonPointer`, or returns null if the query fails due to a missing key.
`java.lang.String`	`optString(java.lang.String key)`	Get an optional string associated with a key.
`java.lang.String`	`optString(java.lang.String key, java.lang.String defaultValue)`	Get an optional string associated with a key.
`private static boolean`	`parseEndOfKeyValuePair(JSONTokener jsonTokener, JSONParserConfiguration jsonParserConfiguration, boolean isInitial)`	Checks for valid end of key:value pair
`private boolean`	`parseJSONObject(JSONTokener jsonTokener, JSONParserConfiguration jsonParserConfiguration, boolean isInitial)`	Parses entirety of JSON object
`private void`	`populateMap(java.lang.Object bean, java.util.Set<java.lang.Object> objectsRecord, JSONParserConfiguration jsonParserConfiguration)`	Convert a bean into a json object
`private void`	`populateMap(java.lang.Object bean, JSONParserConfiguration jsonParserConfiguration)`	Populates the internal map of the JSONObject with the bean properties.
`private static void`	`processJsonStringToWriteValue(java.io.Writer writer, java.lang.Object value)`	Convenience function to reduce cog complexity of calling method; writes value if string is valid
`private void`	`processMethod(java.lang.Object bean, java.util.Set<java.lang.Object> objectsRecord, JSONParserConfiguration jsonParserConfiguration, java.lang.reflect.Method method, java.lang.String key)`	Processes method into json object entry if appropriate
`private static void`	`processNumberToWriteValue(java.io.Writer writer, java.lang.Number value)`	Convenience function to reduce cog complexity of calling method; writes value if number is valid
`JSONObject`	`put(java.lang.String key, boolean value)`	Put a key/boolean pair in the JSONObject.
`JSONObject`	`put(java.lang.String key, double value)`	Put a key/double pair in the JSONObject.
`JSONObject`	`put(java.lang.String key, float value)`	Put a key/float pair in the JSONObject.
`JSONObject`	`put(java.lang.String key, int value)`	Put a key/int pair in the JSONObject.
`JSONObject`	`put(java.lang.String key, long value)`	Put a key/long pair in the JSONObject.
`JSONObject`	`put(java.lang.String key, java.lang.Object value)`	Put a key/value pair in the JSONObject.
`JSONObject`	`put(java.lang.String key, java.util.Collection<?> value)`	Put a key/value pair in the JSONObject, where the value will be a JSONArray which is produced from a Collection.
`JSONObject`	`put(java.lang.String key, java.util.Map<?,?> value)`	Put a key/value pair in the JSONObject, where the value will be a JSONObject which is produced from a Map.
`JSONObject`	`putOnce(java.lang.String key, java.lang.Object value)`	Put a key/value pair in the JSONObject, but only if the key and the value are both non-null, and only if there is not already a member with that name.
`JSONObject`	`putOpt(java.lang.String key, java.lang.Object value)`	Put a key/value pair in the JSONObject, but only if the key and the value are both non-null.
`java.lang.Object`	`query(java.lang.String jsonPointer)`	Creates a JSONPointer using an initialization string and tries to match it to an item within this JSONObject.
`java.lang.Object`	`query(JSONPointer jsonPointer)`	Uses a user initialized JSONPointer and tries to match it to an item within this JSONObject.
`static java.lang.String`	`quote(java.lang.String string)`	Produce a string in double quotes with backslash sequences in all the right places.
`static java.io.Writer`	`quote(java.lang.String string, java.io.Writer w)`	Quotes a string and appends the result to a given Writer.
`private static JSONException`	`recursivelyDefinedObjectException(java.lang.String key)`	Create a new JSONException in a common format for recursive object definition.
`java.lang.Object`	`remove(java.lang.String key)`	Remove a name and its value, if present.
`boolean`	`similar(java.lang.Object other)`	Determine if two JSONObjects are similar.
`private <E> E`	`stringToEnum(java.lang.Class<?> enumClass, java.lang.String value)`	Converts a String to an Enum value.
`protected static java.lang.Number`	`stringToNumber(java.lang.String val)`	Converts a string to a number using the narrowest possible type.
`static java.lang.Object`	`stringToValue(java.lang.String str)`	Try to convert a string into a number, boolean, or null.
`static java.lang.Object`	`stringToValue(java.lang.String string, JSONParserConfiguration jsonParserConfiguration)`	Try to convert a string into a number, boolean, or null.
`static void`	`testValidity(java.lang.Object o)`	Throw an exception if the object is a NaN or infinite number.
`JSONArray`	`toJSONArray(JSONArray names)`	Produce a JSONArray containing the values of the members of this JSONObject.
`java.util.Map<java.lang.String,java.lang.Object>`	`toMap()`	Returns a java.util.Map containing all of the entries in this object.
`java.lang.String`	`toString()`	Make a JSON text of this JSONObject.
`java.lang.String`	`toString(int indentFactor)`	Make a pretty-printed JSON text of this JSONObject.
`static java.lang.String`	`valueToString(java.lang.Object value)`	Make a JSON text of an Object value.
`static java.lang.Object`	`wrap(java.lang.Object object)`	Wrap an object, if necessary.
`(package private) static java.lang.Object`	`wrap(java.lang.Object object, int recursionDepth, JSONParserConfiguration jsonParserConfiguration)`	Wrap an object, if necessary.
`private static java.lang.Object`	`wrap(java.lang.Object object, java.util.Set<java.lang.Object> objectsRecord)`
`private static java.lang.Object`	`wrap(java.lang.Object object, java.util.Set<java.lang.Object> objectsRecord, int recursionDepth, JSONParserConfiguration jsonParserConfiguration)`
`java.io.Writer`	`write(java.io.Writer writer)`	Write the contents of the JSONObject as JSON text to a writer.
`java.io.Writer`	`write(java.io.Writer writer, int indentFactor, int indent)`	Write the contents of the JSONObject as JSON text to a writer.
`private static void`	`writeAsHex(java.io.Writer w, char c)`	Convenience method to reduce cognitive complexity of quote()
`private void`	`writeContent(java.io.Writer writer, int indentFactor, int indent, boolean needsComma)`	Convenience function.
`(package private) static java.io.Writer`	`writeValue(java.io.Writer writer, java.lang.Object value, int indentFactor, int indent)`
`private static JSONException`	`wrongValueFormatException(java.lang.String key, java.lang.String valueType, java.lang.Object value, java.lang.Throwable cause)`	Create a new JSONException in a common format for incorrect conversions.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NUMBER_PATTERN
```
static final java.util.regex.Pattern NUMBER_PATTERN
```
    Regular Expression Pattern that matches JSON Numbers. This is primarily used for output to guarantee that we are always writing valid JSON.
  - map
```
private final java.util.Map<java.lang.String,java.lang.Object> map
```
    The map where the JSONObject's properties are kept.
  - NULL
```
public static final java.lang.Object NULL
```
    It is sometimes more convenient and less ambiguous to have a NULL object than to use Java's null value. JSONObject.NULL.equals(null) returns true. JSONObject.NULL.toString() returns "null".
  - EXCLUDED_RECORD_METHOD_NAMES
```
private static final java.util.Set<java.lang.String> EXCLUDED_RECORD_METHOD_NAMES
```
    Set of method names that should be excluded when identifying record-style accessors. These are common bean/Object method names that are not property accessors.
- Constructor Detail
  - JSONObject
```
public JSONObject()
```
    Construct an empty JSONObject.
  - JSONObject
```
public JSONObject(JSONObject jo,
                  java.lang.String... names)
```
    Construct a JSONObject from a subset of another JSONObject. An array of strings is used to identify the keys that should be copied. Missing keys are ignored.
    
    Parameters:
    
    jo - A JSONObject.
    
    names - An array of strings.
  - JSONObject
```
public JSONObject(JSONTokener x)
           throws JSONException
```
    Construct a JSONObject from a JSONTokener.
    
    Parameters:
    
    x - A JSONTokener object containing the source string.
    
    Throws:
    
    JSONException - If there is a syntax error in the source string or a duplicated key.
  - JSONObject
```
public JSONObject(JSONTokener x,
                  JSONParserConfiguration jsonParserConfiguration)
           throws JSONException
```
    Construct a JSONObject from a JSONTokener with custom json parse configurations.
    
    Parameters:
    
    x - A JSONTokener object containing the source string.
    
    jsonParserConfiguration - Variable to pass parser custom configuration for json parsing.
    
    Throws:
    
    JSONException - If there is a syntax error in the source string or a duplicated key.
  - JSONObject
```
public JSONObject(java.util.Map<?,?> m)
```
    Construct a JSONObject from a Map.
    
    Parameters:
    
    m - A map object that can be used to initialize the contents of the JSONObject.
    
    Throws:
    
    JSONException - If a value in the map is non-finite number.
    
    java.lang.NullPointerException - If a key in the map is null
  - JSONObject
```
public JSONObject(java.util.Map<?,?> m,
                  JSONParserConfiguration jsonParserConfiguration)
```
    Construct a JSONObject from a Map with custom json parse configurations.
    
    Parameters:
    
    m - A map object that can be used to initialize the contents of the JSONObject.
    
    jsonParserConfiguration - Variable to pass parser custom configuration for json parsing.
  - JSONObject
```
private JSONObject(java.util.Map<?,?> m,
                   int recursionDepth,
                   JSONParserConfiguration jsonParserConfiguration)
```
    Construct a JSONObject from a map with recursion depth.
  - JSONObject
```
public JSONObject(java.lang.Object bean)
```
    Construct a JSONObject from an Object using bean getters. It reflects on all of the public methods of the object. For each of the methods with no parameters and a name starting with "get" or "is" followed by an uppercase letter, the method is invoked, and a key and the value returned from the getter method are put into the new JSONObject.
    The key is formed by removing the "get" or "is" prefix. If the second remaining character is not upper case, then the first character is converted to lower case.
    Methods that are static, return void, have parameters, or are "bridge" methods, are ignored.
    For example, if an object has a method named "getName", and if the result of calling object.getName() is "Larry Fine", then the JSONObject will contain "name": "Larry Fine".
    The JSONPropertyName annotation can be used on a bean getter to override key name used in the JSONObject. For example, using the object above with the getName method, if we annotated it with:
    @JSONPropertyName("FullName") public String getName() { return this.name; }
    The resulting JSON object would contain "FullName": "Larry Fine"
    Similarly, the JSONPropertyName annotation can be used on non- get and is methods. We can also override key name used in the JSONObject as seen below even though the field would normally be ignored:
    @JSONPropertyName("FullName") public String fullName() { return this.name; }
    The resulting JSON object would contain "FullName": "Larry Fine"
    The JSONPropertyIgnore annotation can be used to force the bean property to not be serialized into JSON. If both JSONPropertyIgnore and JSONPropertyName are defined on the same method, a depth comparison is performed and the one closest to the concrete class being serialized is used. If both annotations are at the same level, then the JSONPropertyIgnore annotation takes precedent and the field is not serialized. For example, the following declaration would prevent the getName method from being serialized:
    @JSONPropertyName("FullName") @JSONPropertyIgnore public String getName() { return this.name; }
    Parameters:
    
    bean - An object that has getter methods that should be used to make a JSONObject.
    
    Throws:
    
    JSONException - If a getter returned a non-finite number.
  - JSONObject
```
public JSONObject(java.lang.Object bean,
                  JSONParserConfiguration jsonParserConfiguration)
```
  - JSONObject
```
private JSONObject(java.lang.Object bean,
                   java.util.Set<java.lang.Object> objectsRecord)
```
  - JSONObject
```
public JSONObject(java.lang.Object object,
                  java.lang.String... names)
```
    Construct a JSONObject from an Object, using reflection to find the public members. The resulting JSONObject's keys will be the strings from the names array, and the values will be the field values associated with those keys in the object. If a key is not found or not visible, then it will not be copied into the new JSONObject.
    
    Parameters:
    
    object - An object that has fields that should be used to make a JSONObject.
    
    names - An array of strings, the names of the fields to be obtained from the object.
  - JSONObject
```
public JSONObject(java.lang.String source)
           throws JSONException
```
    Construct a JSONObject from a source JSON text string. This is the most commonly used JSONObject constructor.
    
    Parameters:
    
    source - A string beginning with { (left brace) and ending with } (right brace).
    
    Throws:
    
    JSONException - If there is a syntax error in the source string or a duplicated key.
  - JSONObject
```
public JSONObject(java.lang.String source,
                  JSONParserConfiguration jsonParserConfiguration)
           throws JSONException
```
    Construct a JSONObject from a source JSON text string with custom json parse configurations. This is the most commonly used JSONObject constructor.
    
    Parameters:
    
    source - A string beginning with { (left brace) and ending with } (right brace).
    
    jsonParserConfiguration - Variable to pass parser custom configuration for json parsing.
    
    Throws:
    
    JSONException - If there is a syntax error in the source string or a duplicated key.
  - JSONObject
```
public JSONObject(java.lang.String baseName,
                  java.util.Locale locale)
           throws JSONException
```
    Construct a JSONObject from a ResourceBundle.
    
    Parameters:
    
    baseName - The ResourceBundle base name.
    
    locale - The Locale to load the ResourceBundle for.
    
    Throws:
    
    JSONException - If any JSONExceptions are detected.
  - JSONObject
```
protected JSONObject(int initialCapacity)
```
    Constructor to specify an initial capacity of the internal map. Useful for library internal calls where we know, or at least can best guess, how big this JSONObject will be.
    
    Parameters:
    
    initialCapacity - initial capacity of the internal map.
- Method Detail
  - getMapType
```
public java.lang.Class<? extends java.util.Map> getMapType()
```
    Retrieves the type of the underlying Map in this class.
    
    Returns:
    
    The class object representing the type of the underlying Map.
  - parseJSONObject
```
private boolean parseJSONObject(JSONTokener jsonTokener,
                                JSONParserConfiguration jsonParserConfiguration,
                                boolean isInitial)
```
    Parses entirety of JSON object
    
    Parameters:
    
    jsonTokener - Parses text as tokens
    
    jsonParserConfiguration - Variable to pass parser custom configuration for json parsing.
    
    isInitial - True if start of document, else false
    
    Returns:
    
    True if done building object, else false
  - parseEndOfKeyValuePair
```
private static boolean parseEndOfKeyValuePair(JSONTokener jsonTokener,
                                              JSONParserConfiguration jsonParserConfiguration,
                                              boolean isInitial)
```
    Checks for valid end of key:value pair
    
    Parameters:
    
    jsonTokener - Parses text as tokens
    
    jsonParserConfiguration - Variable to pass parser custom configuration for json parsing.
    
    isInitial - True if end of JSON object, else false
    
    Returns:
  - checkKeyForStrictMode
```
private static void checkKeyForStrictMode(JSONTokener jsonTokener,
                                          JSONParserConfiguration jsonParserConfiguration,
                                          java.lang.Object obj)
```
    Throws error if key violates strictMode
    
    Parameters:
    
    jsonTokener - Parses text as tokens
    
    jsonParserConfiguration - Variable to pass parser custom configuration for json parsing.
    
    obj - Value to be checked
  - accumulate
```
public JSONObject accumulate(java.lang.String key,
                             java.lang.Object value)
                      throws JSONException
```
    Accumulate values under a key. It is similar to the put method except that if there is already an object stored under the key then a JSONArray is stored under the key to hold all of the accumulated values. If there is already a JSONArray, then the new value is appended to it. In contrast, the put method replaces the previous value. If only one value is accumulated that is not a JSONArray, then the result will be the same as using put. But if multiple values are accumulated, then the result will be like append.
    
    Parameters:
    
    key - A key string.
    
    value - An object to be accumulated under the key.
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - If the value is non-finite number.
    
    java.lang.NullPointerException - If the key is null.
  - append
```
public JSONObject append(java.lang.String key,
                         java.lang.Object value)
                  throws JSONException
```
    Append values to the array under a key. If the key does not exist in the JSONObject, then the key is put in the JSONObject with its value being a JSONArray containing the value parameter. If the key was already associated with a JSONArray, then the value parameter is appended to it.
    
    Parameters:
    
    key - A key string.
    
    value - An object to be accumulated under the key.
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - If the value is non-finite number or if the current value associated with the key is not a JSONArray.
    
    java.lang.NullPointerException - If the key is null.
  - doubleToString
```
public static java.lang.String doubleToString(double d)
```
    Produce a string from a double. The string "null" will be returned if the number is not finite.
    
    Parameters:
    
    d - A double.
    
    Returns:
    
    A String.
  - get
```
public java.lang.Object get(java.lang.String key)
                     throws JSONException
```
    Get the value object associated with a key.
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    The object associated with the key.
    
    Throws:
    
    JSONException - if the key is not found.
  - getEnum
```
public <E extends java.lang.Enum<E>> E getEnum(java.lang.Class<E> clazz,
                                               java.lang.String key)
                                        throws JSONException
```
    Get the enum value associated with a key.
    
    Type Parameters:
    
    E - Enum Type
    
    Parameters:
    
    clazz - The type of enum to retrieve.
    
    key - A key string.
    
    Returns:
    
    The enum value associated with the key
    
    Throws:
    
    JSONException - if the key is not found or if the value cannot be converted to an enum.
  - getBoolean
```
public boolean getBoolean(java.lang.String key)
                   throws JSONException
```
    Get the boolean value associated with a key.
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    The truth.
    
    Throws:
    
    JSONException - if the value is not a Boolean or the String "true" or "false".
  - getBigInteger
```
public java.math.BigInteger getBigInteger(java.lang.String key)
                                   throws JSONException
```
    Get the BigInteger value associated with a key.
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    The numeric value.
    
    Throws:
    
    JSONException - if the key is not found or if the value cannot be converted to BigInteger.
  - getBigInteger
```
public java.math.BigInteger getBigInteger(java.lang.String key,
                                          JSONParserConfiguration jsonParserConfiguration)
                                   throws JSONException
```
    Get the BigInteger value associated with a key.
    
    Parameters:
    
    key - A key string.
    
    jsonParserConfiguration - A configuration whose maxNumberLength bounds the number of decimal digits in the returned integer. Values exceeding this length are treated as unconvertible. Pass a configuration with ParserConfiguration.UNDEFINED_MAXIMUM_NUMBER_LENGTH to disable this check.
    
    Returns:
    
    The numeric value.
    
    Throws:
    
    JSONException - if the key is not found or if the value cannot be converted to BigInteger.
  - getBigDecimal
```
public java.math.BigDecimal getBigDecimal(java.lang.String key)
                                   throws JSONException
```
    Get the BigDecimal value associated with a key. If the value is float or double, the BigDecimal(double) constructor will be used. See notes on the constructor for conversion issues that may arise.
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    The numeric value.
    
    Throws:
    
    JSONException - if the key is not found or if the value cannot be converted to BigDecimal.
  - getDouble
```
public double getDouble(java.lang.String key)
                 throws JSONException
```
    Get the double value associated with a key.
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    The numeric value.
    
    Throws:
    
    JSONException - if the key is not found or if the value is not a Number object and cannot be converted to a number.
  - getFloat
```
public float getFloat(java.lang.String key)
               throws JSONException
```
    Get the float value associated with a key.
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    The numeric value.
    
    Throws:
    
    JSONException - if the key is not found or if the value is not a Number object and cannot be converted to a number.
  - getNumber
```
public java.lang.Number getNumber(java.lang.String key)
                           throws JSONException
```
    Get the Number value associated with a key.
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    The numeric value.
    
    Throws:
    
    JSONException - if the key is not found or if the value is not a Number object and cannot be converted to a number.
  - getInt
```
public int getInt(java.lang.String key)
           throws JSONException
```
    Get the int value associated with a key.
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    The integer value.
    
    Throws:
    
    JSONException - if the key is not found or if the value cannot be converted to an integer.
  - getJSONArray
```
public JSONArray getJSONArray(java.lang.String key)
                       throws JSONException
```
    Get the JSONArray value associated with a key.
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    A JSONArray which is the value.
    
    Throws:
    
    JSONException - if the key is not found or if the value is not a JSONArray.
  - getJSONObject
```
public JSONObject getJSONObject(java.lang.String key)
                         throws JSONException
```
    Get the JSONObject value associated with a key.
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    A JSONObject which is the value.
    
    Throws:
    
    JSONException - if the key is not found or if the value is not a JSONObject.
  - getLong
```
public long getLong(java.lang.String key)
             throws JSONException
```
    Get the long value associated with a key.
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    The long value.
    
    Throws:
    
    JSONException - if the key is not found or if the value cannot be converted to a long.
  - getNames
```
public static java.lang.String[] getNames(JSONObject jo)
```
    Get an array of field names from a JSONObject.
    
    Parameters:
    
    jo - JSON object
    
    Returns:
    
    An array of field names, or null if there are no names.
  - getNames
```
public static java.lang.String[] getNames(java.lang.Object object)
```
    Get an array of public field names from an Object.
    
    Parameters:
    
    object - object to read
    
    Returns:
    
    An array of field names, or null if there are no names.
  - getString
```
public java.lang.String getString(java.lang.String key)
                           throws JSONException
```
    Get the string associated with a key.
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    A string which is the value.
    
    Throws:
    
    JSONException - if there is no string value for the key.
  - has
```
public boolean has(java.lang.String key)
```
    Determine if the JSONObject contains a specific key.
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    true if the key exists in the JSONObject.
  - increment
```
public JSONObject increment(java.lang.String key)
                     throws JSONException
```
    Increment a property of a JSONObject. If there is no such property, create one with a value of 1 (Integer). If there is such a property, and if it is an Integer, Long, Double, Float, BigInteger, or BigDecimal then add one to it. No overflow bounds checking is performed, so callers should initialize the key prior to this call with an appropriate type that can handle the maximum expected value.
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - If there is already a property with this name that is not an Integer, Long, Double, or Float.
  - isNull
```
public boolean isNull(java.lang.String key)
```
    Determine if the value associated with the key is null or if there is no value.
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    true if there is no value associated with the key or if the value is the JSONObject.NULL object.
  - keys
```
public java.util.Iterator<java.lang.String> keys()
```
    Get an enumeration of the keys of the JSONObject. Modifying this key Set will also modify the JSONObject. Use with caution.
    
    Returns:
    
    An iterator of the keys.
    
    See Also:
    
    Set.iterator()
  - keySet
```
public java.util.Set<java.lang.String> keySet()
```
    Get a set of keys of the JSONObject. Modifying this key Set will also modify the JSONObject. Use with caution.
    
    Returns:
    
    A keySet.
    
    See Also:
    
    Map.keySet()
  - entrySet
```
protected java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> entrySet()
```
    Get a set of entries of the JSONObject. These are raw values and may not match what is returned by the JSONObject get* and opt* functions. Modifying the returned EntrySet or the Entry objects contained therein will modify the backing JSONObject. This does not return a clone or a read-only view. Use with caution.
    
    Returns:
    
    An Entry Set
    
    See Also:
    
    Map.entrySet()
  - length
```
public int length()
```
    Get the number of keys stored in the JSONObject.
    
    Returns:
    
    The number of keys in the JSONObject.
  - clear
```
public void clear()
```
    Removes all of the elements from this JSONObject. The JSONObject will be empty after this call returns.
  - isEmpty
```
public boolean isEmpty()
```
    Check if JSONObject is empty.
    
    Returns:
    
    true if JSONObject is empty, otherwise false.
  - names
```
public JSONArray names()
```
    Produce a JSONArray containing the names of the elements of this JSONObject.
    
    Returns:
    
    A JSONArray containing the key strings, or null if the JSONObject is empty.
  - numberToString
```
public static java.lang.String numberToString(java.lang.Number number)
                                       throws JSONException
```
    Produce a string from a Number.
    
    Parameters:
    
    number - A Number
    
    Returns:
    
    A String.
    
    Throws:
    
    JSONException - If n is a non-finite number.
  - opt
```
public java.lang.Object opt(java.lang.String key)
```
    Get an optional value associated with a key.
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    An object which is the value, or null if there is no value.
  - optEnum
```
public <E extends java.lang.Enum<E>> E optEnum(java.lang.Class<E> clazz,
                                               java.lang.String key)
```
    Get the enum value associated with a key.
    
    Type Parameters:
    
    E - Enum Type
    
    Parameters:
    
    clazz - The type of enum to retrieve.
    
    key - A key string.
    
    Returns:
    
    The enum value associated with the key or null if not found
  - optEnum
```
public <E extends java.lang.Enum<E>> E optEnum(java.lang.Class<E> clazz,
                                               java.lang.String key,
                                               E defaultValue)
```
    Get the enum value associated with a key.
    
    Type Parameters:
    
    E - Enum Type
    
    Parameters:
    
    clazz - The type of enum to retrieve.
    
    key - A key string.
    
    defaultValue - The default in case the value is not found
    
    Returns:
    
    The enum value associated with the key or defaultValue if the value is not found or cannot be assigned to clazz
  - optBoolean
```
public boolean optBoolean(java.lang.String key)
```
    Get an optional boolean associated with a key. It returns false if there is no such key, or if the value is not Boolean.TRUE or the String "true".
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    The truth.
  - optBoolean
```
public boolean optBoolean(java.lang.String key,
                          boolean defaultValue)
```
    Get an optional boolean associated with a key. It returns the defaultValue if there is no such key, or if it is not a Boolean or the String "true" or "false" (case insensitive).
    
    Parameters:
    
    key - A key string.
    
    defaultValue - The default.
    
    Returns:
    
    The truth.
  - optBooleanObject
```
public java.lang.Boolean optBooleanObject(java.lang.String key)
```
    Get an optional boolean object associated with a key. It returns false if there is no such key, or if the value is not Boolean.TRUE or the String "true".
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    The truth.
  - optBooleanObject
```
public java.lang.Boolean optBooleanObject(java.lang.String key,
                                          java.lang.Boolean defaultValue)
```
    Get an optional boolean object associated with a key. It returns the defaultValue if there is no such key, or if it is not a Boolean or the String "true" or "false" (case insensitive).
    
    Parameters:
    
    key - A key string.
    
    defaultValue - The default.
    
    Returns:
    
    The truth.
  - optBigDecimal
```
public java.math.BigDecimal optBigDecimal(java.lang.String key,
                                          java.math.BigDecimal defaultValue)
```
    Get an optional BigDecimal associated with a key, or the defaultValue if there is no such key or if its value is not a number. If the value is a string, an attempt will be made to evaluate it as a number. If the value is float or double, then the BigDecimal(double) constructor will be used. See notes on the constructor for conversion issues that may arise.
    
    Parameters:
    
    key - A key string.
    
    defaultValue - The default.
    
    Returns:
    
    An object which is the value.
  - objectToBigDecimal
```
static java.math.BigDecimal objectToBigDecimal(java.lang.Object val,
                                               java.math.BigDecimal defaultValue)
```
    Parameters:
    
    val - value to convert
    
    defaultValue - default value to return is the conversion doesn't work or is null.
    
    Returns:
    
    BigDecimal conversion of the original value, or the defaultValue if unable to convert.
  - objectToBigDecimal
```
static java.math.BigDecimal objectToBigDecimal(java.lang.Object val,
                                               java.math.BigDecimal defaultValue,
                                               boolean exact)
```
    Parameters:
    
    val - value to convert
    
    defaultValue - default value to return is the conversion doesn't work or is null.
    
    exact - When true, then Double and Float values will be converted exactly. When false, they will be converted to String values before converting to BigDecimal.
    
    Returns:
    
    BigDecimal conversion of the original value, or the defaultValue if unable to convert.
  - optBigInteger
```
public java.math.BigInteger optBigInteger(java.lang.String key,
                                          java.math.BigInteger defaultValue)
```
    Get an optional BigInteger associated with a key, or the defaultValue if there is no such key or if its value is not a number. If the value is a string, an attempt will be made to evaluate it as a number.
    
    Parameters:
    
    key - A key string.
    
    defaultValue - The default.
    
    Returns:
    
    An object which is the value.
  - optBigInteger
```
public java.math.BigInteger optBigInteger(java.lang.String key,
                                          java.math.BigInteger defaultValue,
                                          JSONParserConfiguration jsonParserConfiguration)
```
    Get an optional BigInteger associated with a key, or the defaultValue if there is no such key or if its value is not a number. If the value is a string, an attempt will be made to evaluate it as a number.
    
    Parameters:
    
    key - A key string.
    
    defaultValue - The default.
    
    jsonParserConfiguration - A configuration whose maxNumberLength bounds the number of decimal digits in the returned integer. Values exceeding this length are treated as unconvertible and defaultValue is returned. Pass a configuration with ParserConfiguration.UNDEFINED_MAXIMUM_NUMBER_LENGTH to disable this check.
    
    Returns:
    
    An object which is the value.
  - objectToBigInteger
```
static java.math.BigInteger objectToBigInteger(java.lang.Object val,
                                               java.math.BigInteger defaultValue)
```
    Parameters:
    
    val - value to convert
    
    defaultValue - default value to return is the conversion doesn't work or is null.
    
    Returns:
    
    BigInteger conversion of the original value, or the defaultValue if unable to convert.
  - objectToBigInteger
```
static java.math.BigInteger objectToBigInteger(java.lang.Object val,
                                               java.math.BigInteger defaultValue,
                                               JSONParserConfiguration jsonParserConfiguration)
```
    Parameters:
    
    val - value to convert
    
    defaultValue - default value to return is the conversion doesn't work or is null.
    
    jsonParserConfiguration - parser configuration whose maxNumberLength bounds the number of decimal digits in the resulting integer. Values whose integer part would exceed this length are treated as unconvertible and defaultValue is returned. Pass a configuration with ParserConfiguration.UNDEFINED_MAXIMUM_NUMBER_LENGTH to disable this check.
    
    Returns:
    
    BigInteger conversion of the original value, or the defaultValue if unable to convert.
  - attemptConversionToBigInteger
```
private static java.math.BigInteger attemptConversionToBigInteger(java.lang.Object val,
                                                                  java.math.BigInteger defaultValue,
                                                                  int maxNumberLength)
```
    Convenience method to attempt conversion of value to BigInteger. Added to reduce complexity of objectToBigInteger()
    
    Parameters:
    
    val - the value to be converted
    
    defaultValue - the default value to use if conversion is not attempted or fails
    
    maxNumberLength - the max length allowed for BigIntegers
    
    Returns:
    
    the converted value, or the defaultValue
  - optDouble
```
public double optDouble(java.lang.String key)
```
    Get an optional double associated with a key, or NaN if there is no such key or if its value is not a number. If the value is a string, an attempt will be made to evaluate it as a number.
    
    Parameters:
    
    key - A string which is the key.
    
    Returns:
    
    An object which is the value.
  - optDouble
```
public double optDouble(java.lang.String key,
                        double defaultValue)
```
    Get an optional double associated with a key, or the defaultValue if there is no such key or if its value is not a number. If the value is a string, an attempt will be made to evaluate it as a number.
    
    Parameters:
    
    key - A key string.
    
    defaultValue - The default.
    
    Returns:
    
    An object which is the value.
  - optDoubleObject
```
public java.lang.Double optDoubleObject(java.lang.String key)
```
    Get an optional Double object associated with a key, or NaN if there is no such key or if its value is not a number. If the value is a string, an attempt will be made to evaluate it as a number.
    
    Parameters:
    
    key - A string which is the key.
    
    Returns:
    
    An object which is the value.
  - optDoubleObject
```
public java.lang.Double optDoubleObject(java.lang.String key,
                                        java.lang.Double defaultValue)
```
    Get an optional Double object associated with a key, or the defaultValue if there is no such key or if its value is not a number. If the value is a string, an attempt will be made to evaluate it as a number.
    
    Parameters:
    
    key - A key string.
    
    defaultValue - The default.
    
    Returns:
    
    An object which is the value.
  - optFloat
```
public float optFloat(java.lang.String key)
```
    Get the optional float value associated with an index. NaN is returned if there is no value for the index, or if the value is not a number and cannot be converted to a number.
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    The value.
  - optFloat
```
public float optFloat(java.lang.String key,
                      float defaultValue)
```
    Get the optional float value associated with an index. The defaultValue is returned if there is no value for the index, or if the value is not a number and cannot be converted to a number.
    
    Parameters:
    
    key - A key string.
    
    defaultValue - The default value.
    
    Returns:
    
    The value.
  - optFloatObject
```
public java.lang.Float optFloatObject(java.lang.String key)
```
    Get the optional Float object associated with an index. NaN is returned if there is no value for the index, or if the value is not a number and cannot be converted to a number.
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    The object.
  - optFloatObject
```
public java.lang.Float optFloatObject(java.lang.String key,
                                      java.lang.Float defaultValue)
```
    Get the optional Float object associated with an index. The defaultValue is returned if there is no value for the index, or if the value is not a number and cannot be converted to a number.
    
    Parameters:
    
    key - A key string.
    
    defaultValue - The default object.
    
    Returns:
    
    The object.
  - optInt
```
public int optInt(java.lang.String key)
```
    Get an optional int value associated with a key, or zero if there is no such key or if the value is not a number. If the value is a string, an attempt will be made to evaluate it as a number.
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    An object which is the value.
  - optInt
```
public int optInt(java.lang.String key,
                  int defaultValue)
```
    Get an optional int value associated with a key, or the default if there is no such key or if the value is not a number. If the value is a string, an attempt will be made to evaluate it as a number.
    
    Parameters:
    
    key - A key string.
    
    defaultValue - The default.
    
    Returns:
    
    An object which is the value.
  - optIntegerObject
```
public java.lang.Integer optIntegerObject(java.lang.String key)
```
    Get an optional Integer object associated with a key, or zero if there is no such key or if the value is not a number. If the value is a string, an attempt will be made to evaluate it as a number.
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    An object which is the value.
  - optIntegerObject
```
public java.lang.Integer optIntegerObject(java.lang.String key,
                                          java.lang.Integer defaultValue)
```
    Get an optional Integer object associated with a key, or the default if there is no such key or if the value is not a number. If the value is a string, an attempt will be made to evaluate it as a number.
    
    Parameters:
    
    key - A key string.
    
    defaultValue - The default.
    
    Returns:
    
    An object which is the value.
  - optJSONArray
```
public JSONArray optJSONArray(java.lang.String key)
```
    Get an optional JSONArray associated with a key. It returns null if there is no such key, or if its value is not a JSONArray.
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    A JSONArray which is the value.
  - optJSONArray
```
public JSONArray optJSONArray(java.lang.String key,
                              JSONArray defaultValue)
```
    Get an optional JSONArray associated with a key, or the default if there is no such key, or if its value is not a JSONArray.
    
    Parameters:
    
    key - A key string.
    
    defaultValue - The default.
    
    Returns:
    
    A JSONArray which is the value.
  - optJSONObject
```
public JSONObject optJSONObject(java.lang.String key)
```
    Get an optional JSONObject associated with a key. It returns null if there is no such key, or if its value is not a JSONObject.
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    A JSONObject which is the value.
  - optJSONObject
```
public JSONObject optJSONObject(java.lang.String key,
                                JSONObject defaultValue)
```
    Get an optional JSONObject associated with a key, or the default if there is no such key or if the value is not a JSONObject.
    
    Parameters:
    
    key - A key string.
    
    defaultValue - The default.
    
    Returns:
    
    An JSONObject which is the value.
  - optLong
```
public long optLong(java.lang.String key)
```
    Get an optional long value associated with a key, or zero if there is no such key or if the value is not a number. If the value is a string, an attempt will be made to evaluate it as a number.
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    An object which is the value.
  - optLong
```
public long optLong(java.lang.String key,
                    long defaultValue)
```
    Get an optional long value associated with a key, or the default if there is no such key or if the value is not a number. If the value is a string, an attempt will be made to evaluate it as a number.
    
    Parameters:
    
    key - A key string.
    
    defaultValue - The default.
    
    Returns:
    
    An object which is the value.
  - optLongObject
```
public java.lang.Long optLongObject(java.lang.String key)
```
    Get an optional Long object associated with a key, or zero if there is no such key or if the value is not a number. If the value is a string, an attempt will be made to evaluate it as a number.
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    An object which is the value.
  - optLongObject
```
public java.lang.Long optLongObject(java.lang.String key,
                                    java.lang.Long defaultValue)
```
    Get an optional Long object associated with a key, or the default if there is no such key or if the value is not a number. If the value is a string, an attempt will be made to evaluate it as a number.
    
    Parameters:
    
    key - A key string.
    
    defaultValue - The default.
    
    Returns:
    
    An object which is the value.
  - optNumber
```
public java.lang.Number optNumber(java.lang.String key)
```
    Get an optional Number value associated with a key, or null if there is no such key or if the value is not a number. If the value is a string, an attempt will be made to evaluate it as a number (BigDecimal). This method would be used in cases where type coercion of the number value is unwanted.
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    An object which is the value.
  - optNumber
```
public java.lang.Number optNumber(java.lang.String key,
                                  java.lang.Number defaultValue)
```
    Get an optional Number value associated with a key, or the default if there is no such key or if the value is not a number. If the value is a string, an attempt will be made to evaluate it as a number. This method would be used in cases where type coercion of the number value is unwanted.
    
    Parameters:
    
    key - A key string.
    
    defaultValue - The default.
    
    Returns:
    
    An object which is the value.
  - optString
```
public java.lang.String optString(java.lang.String key)
```
    Get an optional string associated with a key. It returns an empty string if there is no such key. If the value is not a string and is not null, then it is converted to a string.
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    A string which is the value.
  - optString
```
public java.lang.String optString(java.lang.String key,
                                  java.lang.String defaultValue)
```
    Get an optional string associated with a key. It returns the defaultValue if there is no such key.
    
    Parameters:
    
    key - A key string.
    
    defaultValue - The default.
    
    Returns:
    
    A string which is the value.
  - populateMap
```
private void populateMap(java.lang.Object bean,
                         JSONParserConfiguration jsonParserConfiguration)
```
    Populates the internal map of the JSONObject with the bean properties. The bean can not be recursive.
    
    Parameters:
    
    bean - the bean
    
    Throws:
    
    JSONException - If a getter returned a non-finite number.
    
    See Also:
    
    JSONObject(Object)
  - populateMap
```
private void populateMap(java.lang.Object bean,
                         java.util.Set<java.lang.Object> objectsRecord,
                         JSONParserConfiguration jsonParserConfiguration)
```
    Convert a bean into a json object
    
    Parameters:
    
    bean - object tobe converted
    
    objectsRecord - set of all objects for this method
    
    jsonParserConfiguration - json parser settings
  - processMethod
```
private void processMethod(java.lang.Object bean,
                           java.util.Set<java.lang.Object> objectsRecord,
                           JSONParserConfiguration jsonParserConfiguration,
                           java.lang.reflect.Method method,
                           java.lang.String key)
```
    Processes method into json object entry if appropriate
    
    Parameters:
    
    bean - object being processed (owns the method)
    
    objectsRecord - set of all objects for this method
    
    jsonParserConfiguration - json parser settings
    
    method - method being processed
    
    key - name of the method
  - isRecordType
```
private static boolean isRecordType(java.lang.Class<?> klass)
```
    Checks if a class is a Java record type. This uses reflection to check for the isRecord() method which was introduced in Java 16. This approach works even when running on Java 6+ JVM.
    
    Parameters:
    
    klass - the class to check
    
    Returns:
    
    true if the class is a record type, false otherwise
  - getMethods
```
private static java.lang.reflect.Method[] getMethods(java.lang.Class<?> klass)
```
    This is a convenience method to simplify populate maps
    
    Parameters:
    
    klass - the name of the object being checked
    
    Returns:
    
    methods of klass
  - isValidMethodName
```
private static boolean isValidMethodName(java.lang.String name)
```
  - getKeyNameFromMethod
```
private static java.lang.String getKeyNameFromMethod(java.lang.reflect.Method method,
                                                     boolean isRecordType)
```
  - isRecordStyleAccessor
```
private static boolean isRecordStyleAccessor(java.lang.String methodName,
                                             java.lang.reflect.Method method)
```
    Checks if a method is a record-style accessor. Record accessors have lowercase names without get/is prefixes and are not inherited from standard Java classes.
    
    Parameters:
    
    methodName - the name of the method
    
    method - the method to check
    
    Returns:
    
    true if this is a record-style accessor, false otherwise
  - annotationValueNotEmpty
```
private static boolean annotationValueNotEmpty(JSONPropertyName annotation)
```
    checks if the annotation is not null and the JSONPropertyName.value() is not null and is not empty.
    
    Parameters:
    
    annotation - the annotation to check
    
    Returns:
    
    true if the annotation and the value is not null and not empty, false otherwise.
  - isValidMethod
```
private static boolean isValidMethod(java.lang.reflect.Method method)
```
    Checks if the method is valid for the populateMap(Object, Set, JSONParserConfiguration) use case
    
    Parameters:
    
    method - the Method to check
    
    Returns:
    
    true, if valid, false otherwise.
  - closeClosable
```
private static void closeClosable(java.lang.Object input)
```
    calls Closeable.close() on the input, if it is an instance of Closable.
    
    Parameters:
    
    input - the input to close, if possible.
  - getAnnotation
```
private static <A extends java.lang.annotation.Annotation> A getAnnotation(java.lang.reflect.Method m,
                                                                           java.lang.Class<A> annotationClass)
```
    Searches the class hierarchy to see if the method or it's super implementations and interfaces has the annotation.
    
    Type Parameters:
    
    A - type of the annotation
    
    Parameters:
    
    m - method to check
    
    annotationClass - annotation to look for
    
    Returns:
    
    the Annotation if the annotation exists on the current method or one of its super class definitions
  - getAnnotationDepth
```
private static int getAnnotationDepth(java.lang.reflect.Method m,
                                      java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass)
```
    Searches the class hierarchy to see if the method or it's super implementations and interfaces has the annotation. Returns the depth of the annotation in the hierarchy.
    
    Parameters:
    
    m - method to check
    
    annotationClass - annotation to look for
    
    Returns:
    
    Depth of the annotation or -1 if the annotation is not on the method.
  - put
```
public JSONObject put(java.lang.String key,
                      boolean value)
               throws JSONException
```
    Put a key/boolean pair in the JSONObject.
    
    Parameters:
    
    key - A key string.
    
    value - A boolean which is the value.
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - If the value is non-finite number.
    
    java.lang.NullPointerException - If the key is null.
  - put
```
public JSONObject put(java.lang.String key,
                      java.util.Collection<?> value)
               throws JSONException
```
    Put a key/value pair in the JSONObject, where the value will be a JSONArray which is produced from a Collection.
    
    Parameters:
    
    key - A key string.
    
    value - A Collection value.
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - If the value is non-finite number.
    
    java.lang.NullPointerException - If the key is null.
  - put
```
public JSONObject put(java.lang.String key,
                      double value)
               throws JSONException
```
    Put a key/double pair in the JSONObject.
    
    Parameters:
    
    key - A key string.
    
    value - A double which is the value.
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - If the value is non-finite number.
    
    java.lang.NullPointerException - If the key is null.
  - put
```
public JSONObject put(java.lang.String key,
                      float value)
               throws JSONException
```
    Put a key/float pair in the JSONObject.
    
    Parameters:
    
    key - A key string.
    
    value - A float which is the value.
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - If the value is non-finite number.
    
    java.lang.NullPointerException - If the key is null.
  - put
```
public JSONObject put(java.lang.String key,
                      int value)
               throws JSONException
```
    Put a key/int pair in the JSONObject.
    
    Parameters:
    
    key - A key string.
    
    value - An int which is the value.
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - If the value is non-finite number.
    
    java.lang.NullPointerException - If the key is null.
  - put
```
public JSONObject put(java.lang.String key,
                      long value)
               throws JSONException
```
    Put a key/long pair in the JSONObject.
    
    Parameters:
    
    key - A key string.
    
    value - A long which is the value.
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - If the value is non-finite number.
    
    java.lang.NullPointerException - If the key is null.
  - put
```
public JSONObject put(java.lang.String key,
                      java.util.Map<?,?> value)
               throws JSONException
```
    Put a key/value pair in the JSONObject, where the value will be a JSONObject which is produced from a Map.
    
    Parameters:
    
    key - A key string.
    
    value - A Map value.
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - If the value is non-finite number.
    
    java.lang.NullPointerException - If the key is null.
  - put
```
public JSONObject put(java.lang.String key,
                      java.lang.Object value)
               throws JSONException
```
    Put a key/value pair in the JSONObject. If the value is null, then the key will be removed from the JSONObject if it is present.
    
    Parameters:
    
    key - A key string.
    
    value - An object which is the value. It should be of one of these types: Boolean, Double, Integer, JSONArray, JSONObject, Long, String, or the JSONObject.NULL object.
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - If the value is non-finite number.
    
    java.lang.NullPointerException - If the key is null.
  - putOnce
```
public JSONObject putOnce(java.lang.String key,
                          java.lang.Object value)
                   throws JSONException
```
    Put a key/value pair in the JSONObject, but only if the key and the value are both non-null, and only if there is not already a member with that name.
    
    Parameters:
    
    key - key to insert into
    
    value - value to insert
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - if the key is a duplicate
  - putOpt
```
public JSONObject putOpt(java.lang.String key,
                         java.lang.Object value)
                  throws JSONException
```
    Put a key/value pair in the JSONObject, but only if the key and the value are both non-null.
    
    Parameters:
    
    key - A key string.
    
    value - An object which is the value. It should be of one of these types: Boolean, Double, Integer, JSONArray, JSONObject, Long, String, or the JSONObject.NULL object.
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - If the value is a non-finite number.
  - query
```
public java.lang.Object query(java.lang.String jsonPointer)
```
    Creates a JSONPointer using an initialization string and tries to match it to an item within this JSONObject. For example, given a JSONObject initialized with this document:
    { "a":{"b":"c"} }
    and this JSONPointer string:
    "/a/b"
    Then this method will return the String "c". A JSONPointerException may be thrown from code called by this method.
    Parameters:
    
    jsonPointer - string that can be used to create a JSONPointer
    
    Returns:
    
    the item matched by the JSONPointer, otherwise null
  - query
```
public java.lang.Object query(JSONPointer jsonPointer)
```
    Uses a user initialized JSONPointer and tries to match it to an item within this JSONObject. For example, given a JSONObject initialized with this document:
    { "a":{"b":"c"} }
    and this JSONPointer:
    "/a/b"
    Then this method will return the String "c". A JSONPointerException may be thrown from code called by this method.
    Parameters:
    
    jsonPointer - string that can be used to create a JSONPointer
    
    Returns:
    
    the item matched by the JSONPointer, otherwise null
  - optQuery
```
public java.lang.Object optQuery(java.lang.String jsonPointer)
```
    Queries and returns a value from this object using jsonPointer, or returns null if the query fails due to a missing key.
    
    Parameters:
    
    jsonPointer - the string representation of the JSON pointer
    
    Returns:
    
    the queried value or null
    
    Throws:
    
    java.lang.IllegalArgumentException - if jsonPointer has invalid syntax
  - optQuery
```
public java.lang.Object optQuery(JSONPointer jsonPointer)
```
    Queries and returns a value from this object using jsonPointer, or returns null if the query fails due to a missing key.
    
    Parameters:
    
    jsonPointer - The JSON pointer
    
    Returns:
    
    the queried value or null
    
    Throws:
    
    java.lang.IllegalArgumentException - if jsonPointer has invalid syntax
  - quote
```
public static java.lang.String quote(java.lang.String string)
```
    Produce a string in double quotes with backslash sequences in all the right places. A backslash will be inserted within </, producing <\/, allowing JSON text to be delivered in HTML. In JSON text, a string cannot contain a control character or an unescaped quote or backslash.
    
    Parameters:
    
    string - A String
    
    Returns:
    
    A String correctly formatted for insertion in a JSON text.
  - quote
```
public static java.io.Writer quote(java.lang.String string,
                                   java.io.Writer w)
                            throws java.io.IOException
```
    Quotes a string and appends the result to a given Writer.
    
    Parameters:
    
    string - The input string to be quoted.
    
    w - The Writer to which the quoted string will be appended.
    
    Returns:
    
    The same Writer instance after appending the quoted string.
    
    Throws:
    
    java.io.IOException - If an I/O error occurs while writing to the Writer.
  - writeAsHex
```
private static void writeAsHex(java.io.Writer w,
                               char c)
                        throws java.io.IOException
```
    Convenience method to reduce cognitive complexity of quote()
    
    Parameters:
    
    w - The Writer to which the quoted string will be appended.
    
    c - Character to write
    
    Throws:
    
    java.io.IOException
  - remove
```
public java.lang.Object remove(java.lang.String key)
```
    Remove a name and its value, if present.
    
    Parameters:
    
    key - The name to be removed.
    
    Returns:
    
    The value that was associated with the name, or null if there was no value.
  - similar
```
public boolean similar(java.lang.Object other)
```
    Determine if two JSONObjects are similar. They must contain the same set of names which must be associated with similar values.
    
    Parameters:
    
    other - The other JSONObject
    
    Returns:
    
    true if they are equal
  - checkSimilarEntries
```
private boolean checkSimilarEntries(java.lang.Object other)
```
  - checkObjectType
```
private boolean checkObjectType(java.lang.Object valueThis,
                                java.lang.Object valueOther)
```
    Convenience function. Compares types of two objects.
    
    Parameters:
    
    valueThis - Object whose type is being checked
    
    valueOther - Reference object
    
    Returns:
    
    true if match, else false
  - isNumberSimilar
```
static boolean isNumberSimilar(java.lang.Number l,
                               java.lang.Number r)
```
    Compares two numbers to see if they are similar. If either of the numbers are Double or Float instances, then they are checked to have a finite value. If either value is not finite (NaN or ±infinity), then this function will always return false. If both numbers are finite, they are first checked to be the same type and implement Comparable. If they do, then the actual Comparable.compareTo(Object) is called. If they are not the same type, or don't implement Comparable, then they are converted to BigDecimals. Finally the BigDecimal values are compared using BigDecimal.compareTo(BigDecimal).
    
    Parameters:
    
    l - the Left value to compare. Can not be null.
    
    r - the right value to compare. Can not be null.
    
    Returns:
    
    true if the numbers are similar, false otherwise.
  - numberIsFinite
```
private static boolean numberIsFinite(java.lang.Number n)
```
  - isDecimalNotation
```
protected static boolean isDecimalNotation(java.lang.String val)
```
    Tests if the value should be tried as a decimal. It makes no test if there are actual digits.
    
    Parameters:
    
    val - value to test
    
    Returns:
    
    true if the string is "-0" or if it contains '.', 'e', or 'E', false otherwise.
  - stringToValue
```
public static java.lang.Object stringToValue(java.lang.String str)
```
    Try to convert a string into a number, boolean, or null. If the string can't be converted, return the string. Warning! stringToValue(String) uses the default max number length. If you want to override it, use a suitable initialized JSONParserConfiguration and the method: stringToValue(String, JSONParserConfiguration).
    
    Parameters:
    
    str - A String. can not be null.
    
    Returns:
    
    A simple JSON value.
    
    Throws:
    
    java.lang.NullPointerException - Thrown if the string is null.
  - stringToValue
```
public static java.lang.Object stringToValue(java.lang.String string,
                                             JSONParserConfiguration jsonParserConfiguration)
```
    Try to convert a string into a number, boolean, or null. If the string can't be converted, return the string.
    
    Parameters:
    
    string - A String. can not be null.
    
    jsonParserConfiguration - the parser config
    
    Returns:
    
    A simple JSON value. If the string represents a number that is too large, a string will be returned.
    
    Throws:
    
    java.lang.NullPointerException - Thrown if the string is null.
  - stringToNumber
```
protected static java.lang.Number stringToNumber(java.lang.String val)
                                          throws java.lang.NumberFormatException
```
    Converts a string to a number using the narrowest possible type. Possible returns for this function are BigDecimal, Double, BigInteger, Long, and Integer. When a Double is returned, it should always be a valid Double and not NaN or +-infinity.
    
    Parameters:
    
    val - value to convert
    
    Returns:
    
    Number representation of the value.
    
    Throws:
    
    java.lang.NumberFormatException - thrown if the value is not a valid number. A public caller should catch this and wrap it in a JSONException if applicable.
  - checkForInvalidNumberFormat
```
private static void checkForInvalidNumberFormat(java.lang.String val,
                                                char initial)
```
    Convenience function. Block items like 00 01 etc. Java number parsers treat these as Octal.
    
    Parameters:
    
    val - value to convert
    
    initial - first char of val
    
    Throws:
    
    exceptions - if numbers are formatted incorrectly
  - getNumber
```
private static java.lang.Number getNumber(java.lang.String val,
                                          char initial)
```
    Convenience function. Handles val if it is a number
    
    Parameters:
    
    val - value to convert
    
    initial - first char of val
    
    Returns:
    
    val as a BigDecimal
  - testValidity
```
public static void testValidity(java.lang.Object o)
                         throws JSONException
```
    Throw an exception if the object is a NaN or infinite number.
    
    Parameters:
    
    o - The object to test.
    
    Throws:
    
    JSONException - If o is a non-finite number.
  - toJSONArray
```
public JSONArray toJSONArray(JSONArray names)
                      throws JSONException
```
    Produce a JSONArray containing the values of the members of this JSONObject.
    
    Parameters:
    
    names - A JSONArray containing a list of key strings. This determines the sequence of the values in the result.
    
    Returns:
    
    A JSONArray of values.
    
    Throws:
    
    JSONException - If any of the values are non-finite numbers.
  - toString
```
public java.lang.String toString()
```
    Make a JSON text of this JSONObject. For compactness, no whitespace is added. If this would not result in a syntactically correct JSON text, then null will be returned instead.
    Warning: This method assumes that the data structure is acyclical.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a printable, displayable, portable, transmittable representation of the object, beginning with { (left brace) and ending with } (right brace).
  - toString
```
public java.lang.String toString(int indentFactor)
                          throws JSONException
```
    Make a pretty-printed JSON text of this JSONObject.
    If
    indentFactor > 0
    and the JSONObject has only one key, then the object will be output on a single line:
    {"key": 1}
    
    If an object has 2 or more keys, then it will be output across multiple lines:
    { "key1": 1, "key2": "value 2", "key3": 3 }
    
    Warning: This method assumes that the data structure is acyclical.
    Parameters:
    
    indentFactor - The number of spaces to add to each level of indentation.
    
    Returns:
    
    a printable, displayable, portable, transmittable representation of the object, beginning with { (left brace) and ending with } (right brace).
    
    Throws:
    
    JSONException - If the object contains an invalid number.
  - valueToString
```
public static java.lang.String valueToString(java.lang.Object value)
                                      throws JSONException
```
    Make a JSON text of an Object value. If the object has an value.toJSONString() method, then that method will be used to produce the JSON text. The method is required to produce a strictly conforming text. If the object does not contain a toJSONString method (which is the most common case), then a text will be produced by other means. If the value is an array or Collection, then a JSONArray will be made from it and its toJSONString method will be called. If the value is a MAP, then a JSONObject will be made from it and its toJSONString method will be called. Otherwise, the value's toString method will be called, and the result will be quoted.
    Warning: This method assumes that the data structure is acyclical.
    
    Parameters:
    
    value - The value to be serialized.
    
    Returns:
    
    a printable, displayable, transmittable representation of the object, beginning with { (left brace) and ending with } (right brace).
    
    Throws:
    
    JSONException - If the value is or contains an invalid number.
  - wrap
```
public static java.lang.Object wrap(java.lang.Object object)
```
    Wrap an object, if necessary. If the object is null, 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.
    
    Parameters:
    
    object - The object to wrap
    
    Returns:
    
    The wrapped value
  - wrap
```
static java.lang.Object wrap(java.lang.Object object,
                             int recursionDepth,
                             JSONParserConfiguration jsonParserConfiguration)
```
    Wrap an object, if necessary. If the object is null, 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.
    
    Parameters:
    
    object - The object to wrap
    
    recursionDepth - Variable for tracking the count of nested object creations.
    
    jsonParserConfiguration - Variable to pass parser custom configuration for json parsing.
    
    Returns:
    
    The wrapped value
  - wrap
```
private static java.lang.Object wrap(java.lang.Object object,
                                     java.util.Set<java.lang.Object> objectsRecord)
```
  - wrap
```
private static java.lang.Object wrap(java.lang.Object object,
                                     java.util.Set<java.lang.Object> objectsRecord,
                                     int recursionDepth,
                                     JSONParserConfiguration jsonParserConfiguration)
```
  - write
```
public java.io.Writer write(java.io.Writer writer)
                     throws JSONException
```
    Write the contents of the JSONObject as JSON text to a writer. For compactness, no whitespace is added.
    Warning: This method assumes that the data structure is acyclical.
    
    Parameters:
    
    writer - the writer object
    
    Returns:
    
    The writer.
    
    Throws:
    
    JSONException - if a called function has an error
  - writeValue
```
static final java.io.Writer writeValue(java.io.Writer writer,
                                       java.lang.Object value,
                                       int indentFactor,
                                       int indent)
                                throws JSONException,
                                       java.io.IOException
```
    Throws:
    
    JSONException
    
    java.io.IOException
  - processJsonStringToWriteValue
```
private static void processJsonStringToWriteValue(java.io.Writer writer,
                                                  java.lang.Object value)
                                           throws java.io.IOException
```
    Convenience function to reduce cog complexity of calling method; writes value if string is valid
    
    Parameters:
    
    writer - Object doing the writing
    
    value - Value to be written
    
    Throws:
    
    java.io.IOException - if something goes wrong
  - processNumberToWriteValue
```
private static void processNumberToWriteValue(java.io.Writer writer,
                                              java.lang.Number value)
                                       throws java.io.IOException
```
    Convenience function to reduce cog complexity of calling method; writes value if number is valid
    
    Parameters:
    
    writer - Object doing the writing
    
    value - Value to be written
    
    Throws:
    
    java.io.IOException - if something goes wrong
  - indent
```
static final void indent(java.io.Writer writer,
                         int indent)
                  throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - write
```
public java.io.Writer write(java.io.Writer writer,
                            int indentFactor,
                            int indent)
                     throws JSONException
```
    Write the contents of the JSONObject as JSON text to a writer.
    If
    indentFactor > 0
    and the JSONObject has only one key, then the object will be output on a single line:
    {"key": 1}
    
    If an object has 2 or more keys, then it will be output across multiple lines:
    { "key1": 1, "key2": "value 2", "key3": 3 }
    
    Warning: This method assumes that the data structure is acyclical.
    Parameters:
    
    writer - Writes the serialized JSON
    
    indentFactor - The number of spaces to add to each level of indentation.
    
    indent - The indentation of the top level.
    
    Returns:
    
    The writer.
    
    Throws:
    
    JSONException - if a called function has an error or a write error occurs
  - writeContent
```
private void writeContent(java.io.Writer writer,
                          int indentFactor,
                          int indent,
                          boolean needsComma)
                   throws java.io.IOException
```
    Convenience function. Writer attempts to write formatted content
    
    Parameters:
    
    writer - Writes the serialized JSON
    
    indentFactor - The number of spaces to add to each level of indentation.
    
    indent - The indentation of the top level.
    
    needsComma - Boolean flag indicating a comma is needed
    
    Throws:
    
    java.io.IOException - If something goes wrong
  - attemptWriteValue
```
private static void attemptWriteValue(java.io.Writer writer,
                                      int indentFactor,
                                      int indent,
                                      java.util.Map.Entry<java.lang.String,?> entry,
                                      java.lang.String key)
```
    Convenience function. Writer attempts to write a value.
    
    Parameters:
    
    writer - Writes the serialized JSON
    
    indentFactor - The number of spaces to add to each level of indentation.
    
    indent - The indentation of the top level.
    
    entry - Contains the value being written
    
    key - Identifies the value
    
    Throws:
    
    JSONException - if a called function has an error or a write error occurs
  - toMap
```
public java.util.Map<java.lang.String,java.lang.Object> toMap()
```
    Returns a java.util.Map containing all of the entries in this object. If an entry in the object is a JSONArray or JSONObject it will also be converted.
    Warning: This method assumes that the data structure is acyclical.
    
    Returns:
    
    a java.util.Map containing the entries of this object
  - wrongValueFormatException
```
private static JSONException wrongValueFormatException(java.lang.String key,
                                                       java.lang.String valueType,
                                                       java.lang.Object value,
                                                       java.lang.Throwable cause)
```
    Create a new JSONException in a common format for incorrect conversions.
    
    Parameters:
    
    key - name of the key
    
    valueType - the type of value being coerced to
    
    cause - optional cause of the coercion failure
    
    Returns:
    
    JSONException that can be thrown.
  - recursivelyDefinedObjectException
```
private static JSONException recursivelyDefinedObjectException(java.lang.String key)
```
    Create a new JSONException in a common format for recursive object definition.
    
    Parameters:
    
    key - name of the key
    
    Returns:
    
    JSONException that can be thrown.
  - getRawType
```
private java.lang.Class<?> getRawType(java.lang.reflect.Type type)
```
    Helper method to extract the raw Class from Type.
  - getElementType
```
private java.lang.reflect.Type getElementType(java.lang.reflect.Type type)
```
    Extracts the element Type for a Collection Type.
  - getMapTypes
```
private java.lang.reflect.Type[] getMapTypes(java.lang.reflect.Type type)
```
    Extracts the key and value Types for a Map Type.
  - fromJson
```
public static <T> T fromJson(java.lang.String jsonString,
                             java.lang.Class<T> clazz)
```
    Deserializes a JSON string into an instance of the specified class.
    This method attempts to map JSON key-value pairs to the corresponding fields of the given class. It supports basic data types including int, double, float, long, and boolean (as well as their boxed counterparts). The class must have a no-argument constructor, and the field names in the class must match the keys in the JSON string.
    
    Type Parameters:
    
    T - the type of the object to return
    
    Parameters:
    
    jsonString - json in string format
    
    clazz - the class of the object to be returned
    
    Returns:
    
    an instance of Object T with fields populated from the JSON string
  - fromJson
```
public <T> T fromJson(java.lang.Class<T> clazz)
```
    Deserializes a JSON string into an instance of the specified class.
    This method attempts to map JSON key-value pairs to the corresponding fields of the given class. It supports basic data types including int, double, float, long, and boolean, as well as their boxed counterparts. The target class must have a no-argument constructor, and its field names must match the keys in the JSON string. Static fields are ignored.
    Note: Only classes that are explicitly supported and registered within the JSONObject context can be deserialized. If the provided class is not among those, this method will not be able to deserialize it. This ensures that only a limited and controlled set of types can be instantiated from JSON for safety and predictability.
    
    Type Parameters:
    
    T - the type of the object
    
    Parameters:
    
    clazz - the class of the object to be returned
    
    Returns:
    
    an instance of type T with fields populated from the JSON string
    
    Throws:
    
    java.lang.IllegalArgumentException - if the class is not supported for deserialization
  - convertValue
```
private java.lang.Object convertValue(java.lang.Object value,
                                      java.lang.reflect.Type targetType)
                               throws JSONException
```
    Recursively converts a value to the target Type, handling nested generics for Collections and Maps.
    
    Throws:
    
    JSONException
  - convertToMap
```
private java.util.Map<?,?> convertToMap(JSONObject jsonMap,
                                              java.lang.reflect.Type keyType,
                                              java.lang.reflect.Type valueType,
                                              java.lang.Class<?> mapType)
                                       throws JSONException
```
    Converts a JSONObject to a Map with the specified generic key and value Types. Supports nested types via recursive convertValue.
    
    Throws:
    
    JSONException
  - stringToEnum
```
private <E> E stringToEnum(java.lang.Class<?> enumClass,
                           java.lang.String value)
                    throws JSONException
```
    Converts a String to an Enum value. The unchecked warning is suppressed when casting valueOf() to E
    
    Type Parameters:
    
    E - type of enum
    
    Parameters:
    
    enumClass - enum class
    
    value - value of enum
    
    Throws:
    
    JSONException
  - fromJsonArray
```
private <T> java.util.Collection<T> fromJsonArray(JSONArray jsonArray,
                                                  java.lang.Class<?> collectionType,
                                                  java.lang.reflect.Type elementType)
                                           throws JSONException
```
    Deserializes a JSONArray into a Collection, supporting nested generics. Uses recursive convertValue for elements.
    
    Throws:
    
    JSONException
  - getCollection
```
private java.util.Collection getCollection(java.lang.Class<?> collectionType)
                                    throws JSONException
```
    Creates and returns a new instance of a supported Collection implementation based on the specified collection type.
    This method currently supports the following collection types:
    
    List.class
    
    ArrayList.class
    
    Set.class
    
    HashSet.class
    
    If the provided type does not match any of the supported types, a JSONException is thrown.
    Parameters:
    
    collectionType - the Class object representing the desired collection type
    
    Returns:
    
    a new empty instance of the specified collection type
    
    Throws:
    
    JSONException - if the specified type is not a supported collection type

Class JSONObject

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NUMBER_PATTERN

map

NULL

EXCLUDED_RECORD_METHOD_NAMES

Constructor Detail

JSONObject

JSONObject

JSONObject

JSONObject

JSONObject

JSONObject

JSONObject

JSONObject

JSONObject

JSONObject

JSONObject

JSONObject

JSONObject

JSONObject

JSONObject

Method Detail

getMapType

parseJSONObject

parseEndOfKeyValuePair

checkKeyForStrictMode

accumulate

append

doubleToString

get

getEnum

getBoolean

getBigInteger

getBigInteger

getBigDecimal

getDouble

getFloat

getNumber

getInt

getJSONArray

getJSONObject

getLong

getNames

getNames

getString

has

increment

isNull

keys

keySet

entrySet

length

clear

isEmpty

names

numberToString

opt

optEnum

optEnum

optBoolean

optBoolean

optBooleanObject

optBooleanObject

optBigDecimal

objectToBigDecimal

objectToBigDecimal

optBigInteger

optBigInteger

objectToBigInteger

objectToBigInteger

attemptConversionToBigInteger

optDouble

optDouble

optDoubleObject