Class JSONObject
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 wordstrue
,false
, ornull
.
- Version:
- 2016-08-15
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static final class
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
FieldsModifier and TypeFieldDescriptionThe map where the JSONObject's properties are kept.static final Object
It is sometimes more convenient and less ambiguous to have aNULL
object than to use Java'snull
value.(package private) static final Pattern
Regular Expression Pattern that matches JSON Numbers. -
Constructor Summary
ConstructorsModifierConstructorDescriptionConstruct an empty JSONObject.protected
JSONObject
(int initialCapacity) Constructor to specify an initial capacity of the internal map.JSONObject
(Object bean) Construct a JSONObject from an Object using bean getters.JSONObject
(Object object, String... names) Construct a JSONObject from an Object, using reflection to find the public members.private
JSONObject
(Object bean, Set<Object> objectsRecord) JSONObject
(String source) Construct a JSONObject from a source JSON text string.JSONObject
(String baseName, Locale locale) Construct a JSONObject from a ResourceBundle.JSONObject
(String source, JSONParserConfiguration jsonParserConfiguration) Construct a JSONObject from a source JSON text string with custom json parse configurations.JSONObject
(Map<?, ?> m) Construct a JSONObject from a Map.private
JSONObject
(Map<?, ?> m, int recursionDepth, JSONParserConfiguration jsonParserConfiguration) Construct a JSONObject from a map with recursion depth.JSONObject
(Map<?, ?> m, JSONParserConfiguration jsonParserConfiguration) Construct a JSONObject from a Map with custom json parse configurations.JSONObject
(JSONObject jo, String... names) Construct a JSONObject from a subset of another JSONObject.Construct a JSONObject from a JSONTokener.JSONObject
(JSONTokener x, JSONParserConfiguration jsonParserConfiguration) Construct a JSONObject from a JSONTokener with custom json parse configurations. -
Method Summary
Modifier and TypeMethodDescriptionaccumulate
(String key, Object value) Accumulate values under a key.Append values to the array under a key.void
clear()
Removes all of the elements from this JSONObject.static String
doubleToString
(double d) Produce a string from a double.entrySet()
Get a set of entries of the JSONObject.Get the value object associated with a key.private static <A extends Annotation>
AgetAnnotation
(Method m, 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
(Method m, Class<? extends Annotation> annotationClass) Searches the class hierarchy to see if the method or it's super implementations and interfaces has the annotation.getBigDecimal
(String key) Get the BigDecimal value associated with a key.getBigInteger
(String key) Get the BigInteger value associated with a key.boolean
getBoolean
(String key) Get the boolean value associated with a key.double
Get the double value associated with a key.<E extends Enum<E>>
EGet the enum value associated with a key.float
Get the float value associated with a key.int
Get the int value associated with a key.getJSONArray
(String key) Get the JSONArray value associated with a key.getJSONObject
(String key) Get the JSONObject value associated with a key.private static String
getKeyNameFromMethod
(Method method) long
Get the long value associated with a key.Retrieves the type of the underlying Map in this class.static String[]
Get an array of public field names from an Object.static String[]
getNames
(JSONObject jo) Get an array of field names from a JSONObject.Get the Number value associated with a key.Get the string associated with a key.boolean
Determine if the JSONObject contains a specific key.Increment a property of a JSONObject.(package private) static final void
protected static boolean
isDecimalNotation
(String val) Tests if the value should be tried as a decimal.boolean
isEmpty()
Check if JSONObject is empty.boolean
Determine if the value associated with the key isnull
or if there is no value.(package private) static boolean
isNumberSimilar
(Number l, Number r) Compares two numbers to see if they are similar.private static boolean
isValidMethodName
(String name) keys()
Get an enumeration of the keys of the JSONObject.keySet()
Get a set of keys of the JSONObject.int
length()
Get the number of keys stored in the JSONObject.names()
Produce a JSONArray containing the names of the elements of this JSONObject.private static boolean
static String
numberToString
(Number number) Produce a string from a Number.(package private) static BigDecimal
objectToBigDecimal
(Object val, BigDecimal defaultValue) (package private) static BigDecimal
objectToBigDecimal
(Object val, BigDecimal defaultValue, boolean exact) (package private) static BigInteger
objectToBigInteger
(Object val, BigInteger defaultValue) Get an optional value associated with a key.optBigDecimal
(String key, 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.optBigInteger
(String key, 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.boolean
optBoolean
(String key) Get an optional boolean associated with a key.boolean
optBoolean
(String key, boolean defaultValue) Get an optional boolean associated with a key.optBooleanObject
(String key) Get an optional boolean object associated with a key.optBooleanObject
(String key, Boolean defaultValue) Get an optional boolean object associated with a key.double
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
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.optDoubleObject
(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.optDoubleObject
(String key, 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 Enum<E>>
EGet the enum value associated with a key.<E extends Enum<E>>
EGet the enum value associated with a key.float
Get the optional float value associated with an index.float
Get the optional float value associated with an index.optFloatObject
(String key) Get the optional Float object associated with an index.optFloatObject
(String key, Float defaultValue) Get the optional Float object associated with an index.int
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
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.optIntegerObject
(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.optIntegerObject
(String key, 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.optJSONArray
(String key) Get an optional JSONArray associated with a key.optJSONArray
(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.optJSONObject
(String key) Get an optional JSONObject associated with a key.optJSONObject
(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
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
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.optLongObject
(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.optLongObject
(String key, 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.Get an optionalNumber
value associated with a key, ornull
if there is no such key or if the value is not a number.Get an optionalNumber
value associated with a key, or the default if there is no such key or if the value is not a number.Queries and returns a value from this object usingjsonPointer
, or returns null if the query fails due to a missing key.optQuery
(JSONPointer jsonPointer) Queries and returns a value from this object usingjsonPointer
, or returns null if the query fails due to a missing key.Get an optional string associated with a key.Get an optional string associated with a key.private void
populateMap
(Object bean) Populates the internal map of the JSONObject with the bean properties.private void
populateMap
(Object bean, Set<Object> objectsRecord) Put a key/boolean pair in the JSONObject.Put a key/double pair in the JSONObject.Put a key/float pair in the JSONObject.Put a key/int pair in the JSONObject.Put a key/long pair in the JSONObject.Put a key/value pair in the JSONObject.put
(String key, Collection<?> value) Put a key/value pair in the JSONObject, where the value will be a JSONArray which is produced from a Collection.Put a key/value pair in the JSONObject, where the value will be a JSONObject which is produced from a Map.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.Put a key/value pair in the JSONObject, but only if the key and the value are both non-null.Creates a JSONPointer using an initialization string and tries to match it to an item within this JSONObject.query
(JSONPointer jsonPointer) Uses a user initialized JSONPointer and tries to match it to an item within this JSONObject.static String
Produce a string in double quotes with backslash sequences in all the right places.static Writer
Quotes a string and appends the result to a given Writer.private static JSONException
Create a new JSONException in a common format for recursive object definition.Remove a name and its value, if present.private static String
removeLeadingZerosOfNumber
(String value) For a prospective number, remove the leading zerosboolean
Determine if two JSONObjects are similar.protected static Number
stringToNumber
(String val) Converts a string to a number using the narrowest possible type.static Object
stringToValue
(String string) Try to convert a string into a number, boolean, or null.static void
Throw an exception if the object is a NaN or infinite number.toJSONArray
(JSONArray names) Produce a JSONArray containing the values of the members of this JSONObject.toMap()
Returns a java.util.Map containing all of the entries in this object.toString()
Make a JSON text of this JSONObject.toString
(int indentFactor) Make a pretty-printed JSON text of this JSONObject.static String
valueToString
(Object value) Make a JSON text of an Object value.static Object
Wrap an object, if necessary.(package private) static Object
wrap
(Object object, int recursionDepth, JSONParserConfiguration jsonParserConfiguration) Wrap an object, if necessary.private static Object
private static Object
wrap
(Object object, Set<Object> objectsRecord, int recursionDepth, JSONParserConfiguration jsonParserConfiguration) Write the contents of the JSONObject as JSON text to a writer.Write the contents of the JSONObject as JSON text to a writer.(package private) static final Writer
writeValue
(Writer writer, Object value, int indentFactor, int indent) private static JSONException
wrongValueFormatException
(String key, String valueType, Object value, Throwable cause) Create a new JSONException in a common format for incorrect conversions.
-
Field Details
-
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
The map where the JSONObject's properties are kept. -
NULL
It is sometimes more convenient and less ambiguous to have aNULL
object than to use Java'snull
value.JSONObject.NULL.equals(null)
returnstrue
.JSONObject.NULL.toString()
returns"null"
.
-
-
Constructor Details
-
JSONObject
public JSONObject()Construct an empty JSONObject. -
JSONObject
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
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
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.NullPointerException
- If a key in the map isnull
-
JSONObject
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
Construct a JSONObject from a map with recursion depth. -
JSONObject
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
, returnvoid
, have parameters, or are "bridge" methods, are ignored.For example, if an object has a method named
"getName"
, and if the result of callingobject.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 thegetName
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
andis
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 bothJSONPropertyIgnore
andJSONPropertyName
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 theJSONPropertyIgnore
annotation takes precedent and the field is not serialized. For example, the following declaration would prevent thegetName
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
-
JSONObject
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
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(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
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 Details
-
getMapType
Retrieves the type of the underlying Map in this class.- Returns:
- The class object representing the type of the underlying Map.
-
accumulate
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.NullPointerException
- If the key isnull
.
-
append
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.NullPointerException
- If the key isnull
.
-
doubleToString
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
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
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
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
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.
-
getBigDecimal
Get the BigDecimal value associated with a key. If the value is float or double, theBigDecimal(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
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
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
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
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
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
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
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
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
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
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
Determine if the JSONObject contains a specific key.- Parameters:
key
- A key string.- Returns:
- true if the key exists in the JSONObject.
-
increment
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
Determine if the value associated with the key isnull
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
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:
-
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:
-
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:
-
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
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
Produce a string from a Number.- Parameters:
number
- A Number- Returns:
- A String.
- Throws:
JSONException
- If n is a non-finite number.
-
opt
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
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
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
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
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
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
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
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 theBigDecimal(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
- Parameters:
val
- value to convertdefaultValue
- 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
- Parameters:
val
- value to convertdefaultValue
- default value to return is the conversion doesn't work or is null.exact
- Whentrue
, thenDouble
andFloat
values will be converted exactly. Whenfalse
, they will be converted toString
values before converting toBigDecimal
.- Returns:
- BigDecimal conversion of the original value, or the defaultValue if unable to convert.
-
optBigInteger
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.
-
objectToBigInteger
- Parameters:
val
- value to convertdefaultValue
- 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.
-
optDouble
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Get an optionalNumber
value associated with a key, ornull
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
Get an optionalNumber
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
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
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
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:
-
populateMap
-
isValidMethodName
-
getKeyNameFromMethod
-
getAnnotation
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 checkannotationClass
- annotation to look for- Returns:
- the
Annotation
if the annotation exists on the current method or one of its super class definitions
-
getAnnotationDepth
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 checkannotationClass
- annotation to look for- Returns:
- Depth of the annotation or -1 if the annotation is not on the method.
-
put
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.NullPointerException
- If the key isnull
.
-
put
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.NullPointerException
- If the key isnull
.
-
put
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.NullPointerException
- If the key isnull
.
-
put
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.NullPointerException
- If the key isnull
.
-
put
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.NullPointerException
- If the key isnull
.
-
put
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.NullPointerException
- If the key isnull
.
-
put
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.NullPointerException
- If the key isnull
.
-
put
Put a key/value pair in the JSONObject. If the value isnull
, 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.NullPointerException
- If the key isnull
.
-
putOnce
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 intovalue
- value to insert- Returns:
- this.
- Throws:
JSONException
- if the key is a duplicate
-
putOpt
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
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
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
Queries and returns a value from this object usingjsonPointer
, 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:
IllegalArgumentException
- ifjsonPointer
has invalid syntax
-
optQuery
Queries and returns a value from this object usingjsonPointer
, or returns null if the query fails due to a missing key.- Parameters:
jsonPointer
- The JSON pointer- Returns:
- the queried value or
null
- Throws:
IllegalArgumentException
- ifjsonPointer
has invalid syntax
-
quote
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
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:
IOException
- If an I/O error occurs while writing to the Writer.
-
remove
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
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
-
isNumberSimilar
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 implementComparable
. If they do, then the actualComparable.compareTo(Object)
is called. If they are not the same type, or don't implement Comparable, then they are converted toBigDecimal
s. Finally the BigDecimal values are compared usingBigDecimal.compareTo(BigDecimal)
.- Parameters:
l
- the Left value to compare. Can not benull
.r
- the right value to compare. Can not benull
.- Returns:
- true if the numbers are similar, false otherwise.
-
numberIsFinite
-
isDecimalNotation
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
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.- Returns:
- A simple JSON value.
- Throws:
NullPointerException
- Thrown if the string is null.
-
stringToNumber
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:
NumberFormatException
- thrown if the value is not a valid number. A public caller should catch this and wrap it in aJSONException
if applicable.
-
testValidity
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
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
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.
-
toString
Make a pretty-printed JSON text of this JSONObject.If
and theindentFactor > 0
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
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
Wrap an object, if necessary. If the object isnull
, 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 Object wrap(Object object, int recursionDepth, JSONParserConfiguration jsonParserConfiguration) Wrap an object, if necessary. If the object isnull
, 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 wraprecursionDepth
- Variable for tracking the count of nested object creations.jsonParserConfiguration
- Variable to pass parser custom configuration for json parsing.- Returns:
- The wrapped value
-
wrap
-
wrap
private static Object wrap(Object object, Set<Object> objectsRecord, int recursionDepth, JSONParserConfiguration jsonParserConfiguration) -
write
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 Writer writeValue(Writer writer, Object value, int indentFactor, int indent) throws JSONException, IOException - Throws:
JSONException
IOException
-
indent
- Throws:
IOException
-
write
Write the contents of the JSONObject as JSON text to a writer.If
and theindentFactor > 0
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 JSONindentFactor
- 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
-
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(String key, String valueType, Object value, Throwable cause) Create a new JSONException in a common format for incorrect conversions.- Parameters:
key
- name of the keyvalueType
- the type of value being coerced tocause
- optional cause of the coercion failure- Returns:
- JSONException that can be thrown.
-
recursivelyDefinedObjectException
Create a new JSONException in a common format for recursive object definition.- Parameters:
key
- name of the key- Returns:
- JSONException that can be thrown.
-
removeLeadingZerosOfNumber
For a prospective number, remove the leading zeros- Parameters:
value
- prospective number- Returns:
- number without leading zeros
-