Package org.kordamp.json
Class JSONObject
java.lang.Object
org.kordamp.json.AbstractJSON
org.kordamp.json.JSONObject
- All Implemented Interfaces:
Serializable
,Comparable
,Map<String,
,Object> JSON
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 JSONNull
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
element
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 put
methods adds values to 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
. - Keys can be followed by
=
or=>
as well as by:
. - Values can be followed by
;
(semicolon) as well as by,
(comma). - Numbers may have the
0-
(octal) or0x-
(hex) prefix. - Comments written in the slashshlash, slashstar, and hash conventions will be ignored.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static class
static class
This class is considered private API.private static class
private static interface
private static class
private static class
UsesPropertySetStrategy
instead of the normal set method.Nested classes/interfaces inherited from class org.kordamp.json.AbstractJSON
AbstractJSON.WritingVisitor
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final org.slf4j.Logger
private boolean
identifies this object as nullprivate Map
The Map where the JSONObject's properties are kept.private static final long
-
Constructor Summary
ConstructorsConstructorDescriptionConstruct an empty JSONObject.JSONObject
(boolean isNull) Creates a JSONObject that is null. -
Method Summary
Modifier and TypeMethodDescriptionprivate JSONObject
_accumulate
(String key, Object value, JsonConfig jsonConfig) protected Object
_processValue
(Object value, JsonConfig jsonConfig) private JSONObject
_setInternal
(String key, Object value, JsonConfig jsonConfig) Put a key/value pair in the JSONObject.accumulate
(String key, boolean value) Accumulate values under a key.accumulate
(String key, double value) Accumulate values under a key.accumulate
(String key, int value) Accumulate values under a key.accumulate
(String key, long value) Accumulate values under a key.accumulate
(String key, Object value) Accumulate values under a key.accumulate
(String key, Object value, JsonConfig jsonConfig) Accumulate values under a key.void
accumulateAll
(Map map) void
accumulateAll
(Map map, JsonConfig jsonConfig) void
clear()
int
boolean
containsKey
(Object key) boolean
containsValue
(Object value) boolean
containsValue
(Object value, JsonConfig jsonConfig) Remove a name and its value, if present.Put a key/boolean pair in the JSONObject.Put a key/double 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.element
(String key, Object value, JsonConfig jsonConfig) Put a key/value pair in the JSONObject.element
(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.element
(String key, Collection value, JsonConfig jsonConfig) 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.element
(String key, Map value, JsonConfig jsonConfig) Put a key/value pair in the JSONObject, where the value will be a JSONObject which is produced from a Map.elementOpt
(String key, Object value) Put a key/value pair in the JSONObject, but only if the key and the value are both non-null.elementOpt
(String key, Object value, JsonConfig jsonConfig) Put a key/value pair in the JSONObject, but only if the key and the value are both non-null.entrySet()
boolean
static JSONObject
fromObject
(Object object) Creates a JSONObject.
Inspects the object type to call the correct JSONObject factory method.static JSONObject
fromObject
(Object object, JsonConfig jsonConfig) Creates a JSONObject.
Inspects the object type to call the correct JSONObject factory method.Get the value object 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.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.long
Get the long value associated with a key.Get the string associated with a key.boolean
Determine if the JSONObject contains a specific key.int
hashCode()
boolean
isArray()
Returns true if this object is a JSONArray, false otherwise.boolean
isEmpty()
Returns true if this object has no elements or keys.boolean
Returs if this object is a null JSONObject.keys()
Get an enumeration of the keys of the JSONObject.keySet()
names()
Produce a JSONArray containing the names of the elements of this JSONObject.names
(JsonConfig jsonConfig) Produce a JSONArray containing the names of the elements of this JSONObject.Get an optional value associated with a key.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.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.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.optJSONArray
(String key) Get an optional JSONArray associated with a key.optJSONObject
(String key) Get an optional JSONObject associated with a key.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.Get an optional string associated with a key.Get an optional string associated with a key.private Object
processValue
(Object value, JsonConfig jsonConfig) private Object
processValue
(String key, Object value, JsonConfig jsonConfig) void
void
putAll
(Map map, JsonConfig jsonConfig) Remove a name and its value, if present.private JSONObject
setInternal
(String key, Object value, JsonConfig jsonConfig) Put a key/value pair in the JSONObject.int
size()
Get the number of keys stored in the JSONObject.toBean()
Creates a JSONDynaBean from a JSONObject.static Object
toBean
(JSONObject jsonObject) static Object
toBean
(JSONObject jsonObject, Class beanClass) Creates a bean from a JSONObject, with a specific target class.static Object
toBean
(JSONObject jsonObject, Class beanClass, Map classMap) Creates a bean from a JSONObject, with a specific target class.
If beanClass is null, this method will return a graph of DynaBeans.static Object
toBean
(JSONObject jsonObject, Object bean, JsonConfig jsonConfig) Creates a bean from a JSONObject, with the specific configuration.static Object
toBean
(JSONObject jsonObject, JsonConfig jsonConfig) Creates a bean from a JSONObject, with the specific configuration.toJSONArray
(JSONArray names) Produce a JSONArray containing the values of the members of this JSONObject.toString()
Make a JSON text of this JSONObject.toString
(int indentFactor) Make a prettyprinted JSON text of this JSONObject.toString
(int indentFactor, int indent) Make a prettyprinted JSON text of this JSONObject.values()
private void
Checks if this object is a "null" object.protected void
write
(Writer writer, AbstractJSON.WritingVisitor visitor) Write the contents of the JSONObject as JSON text to a writer.Methods inherited from class org.kordamp.json.AbstractJSON
addInstance, fireArrayEndEvent, fireArrayStartEvent, fireElementAddedEvent, fireErrorEvent, fireObjectEndEvent, fireObjectStartEvent, firePropertySetEvent, fireWarnEvent, removeInstance, write, writeCanonical
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.kordamp.json.JSON
write, writeCanonical
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
LOG
private static final org.slf4j.Logger LOG -
nullObject
private boolean nullObjectidentifies this object as null -
properties
The Map where the JSONObject's properties are kept.
-
-
Constructor Details
-
JSONObject
public JSONObject()Construct an empty JSONObject. -
JSONObject
public JSONObject(boolean isNull) Creates a JSONObject that is null.
-
-
Method Details
-
fromObject
Creates a JSONObject.
Inspects the object type to call the correct JSONObject factory method. Accepts JSON formatted strings, Maps, DynaBeans and JavaBeans.- Parameters:
object
-- Throws:
JSONException
- if the object can not be converted to a proper JSONObject.
-
fromObject
Creates a JSONObject.
Inspects the object type to call the correct JSONObject factory method. Accepts JSON formatted strings, Maps, DynaBeans and JavaBeans.- Parameters:
object
-- Throws:
JSONException
- if the object can not be converted to a proper JSONObject.
-
toBean
-
toBean
Creates a bean from a JSONObject, with a specific target class. -
toBean
Creates a bean from a JSONObject, with a specific target class.
If beanClass is null, this method will return a graph of DynaBeans. Any attribute that is a JSONObject and matches a key in the classMap will be converted to that target class.
The classMap has the following conventions:- Every key must be an String.
- Every value must be a Class.
- A key may be a regular expression.
-
toBean
Creates a bean from a JSONObject, with the specific configuration. -
toBean
Creates a bean from a JSONObject, with the specific configuration. -
toBean
Creates a JSONDynaBean from a JSONObject. -
toBean
-
accumulate
Accumulate values under a key. It is similar to the element 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 replace method replaces the previous value.- Parameters:
key
- A key string.value
- An object to be accumulated under the key.- Returns:
- this.
- Throws:
JSONException
- If the value is an invalid number or if the key is null.
-
accumulate
Accumulate values under a key. It is similar to the element 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 replace method replaces the previous value.- Parameters:
key
- A key string.value
- An object to be accumulated under the key.- Returns:
- this.
- Throws:
JSONException
- If the value is an invalid number or if the key is null.
-
accumulate
Accumulate values under a key. It is similar to the element 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 replace method replaces the previous value.- Parameters:
key
- A key string.value
- An object to be accumulated under the key.- Returns:
- this.
- Throws:
JSONException
- If the value is an invalid number or if the key is null.
-
accumulate
Accumulate values under a key. It is similar to the element 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 replace method replaces the previous value.- Parameters:
key
- A key string.value
- An object to be accumulated under the key.- Returns:
- this.
- Throws:
JSONException
- If the value is an invalid number or if the key is null.
-
accumulate
Accumulate values under a key. It is similar to the element 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 replace method replaces the previous value.- Parameters:
key
- A key string.value
- An object to be accumulated under the key.- Returns:
- this.
- Throws:
JSONException
- If the value is an invalid number or if the key is null.
-
accumulate
Accumulate values under a key. It is similar to the element 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 replace method replaces the previous value.- Parameters:
key
- A key string.value
- An object to be accumulated under the key.- Returns:
- this.
- Throws:
JSONException
- If the value is an invalid number or if the key is null.
-
accumulateAll
-
accumulateAll
-
compareTo
- Specified by:
compareTo
in interfaceComparable
-
containsKey
- Specified by:
containsKey
in interfaceMap<String,
Object>
-
containsValue
- Specified by:
containsValue
in interfaceMap<String,
Object>
-
get
-
put
-
remove
-
putAll
-
clear
public void clear() -
keySet
-
values
-
entrySet
-
containsValue
-
discard
Remove a name and its value, if present.- Parameters:
key
- A key string.- Returns:
- this.
-
element
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 key is null.
-
element
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
-
element
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
-
element
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 key is null or if the number is invalid.
-
element
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 key is null.
-
element
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 key is null.
-
element
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
-
element
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
-
element
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.
If there is a previous value assigned to the key, it will call accumulate.- 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 JSONNull object.- Returns:
- this.
- Throws:
JSONException
- If the value is non-finite number or if the key is null.
-
element
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.
If there is a previous value assigned to the key, it will call accumulate.- 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 JSONNull object.- Returns:
- this.
- Throws:
JSONException
- If the value is non-finite number or if the key is null.
-
elementOpt
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 JSONNull object.- Returns:
- this.
- Throws:
JSONException
- If the value is a non-finite number.
-
elementOpt
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 JSONNull object.- Returns:
- this.
- Throws:
JSONException
- If the value is a non-finite number.
-
get
Get the value object associated with a key.- Parameters:
key
- A key string.- Returns:
- The object associated with the key.
- Throws:
JSONException
- if this.isNull() returns true.
-
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".
-
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.
-
getInt
Get the int value associated with a key. If the number value is too large for an int, it will be clipped.- 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. If the number value is too long for a long, it will be clipped.- 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.
-
getString
Get the string associated with a key.- Parameters:
key
- A key string.- Returns:
- A string which is the value.
- Throws:
JSONException
- if the key is not found.
-
has
Determine if the JSONObject contains a specific key.- Parameters:
key
- A key string.- Returns:
- true if the key exists in the JSONObject.
-
hashCode
public int hashCode() -
equals
-
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. -
isArray
public boolean isArray()Description copied from interface:JSON
Returns true if this object is a JSONArray, false otherwise. -
isEmpty
public boolean isEmpty()Description copied from interface:JSON
Returns true if this object has no elements or keys. -
size
public int size()Get the number of keys stored in the JSONObject. -
toString
Make a prettyprinted JSON text of this JSONObject. Warning: This method assumes that the data structure is acyclical.- Specified by:
toString
in interfaceJSON
- 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.
-
toString
Make a prettyprinted JSON text of this JSONObject. Warning: This method assumes that the data structure is acyclical.- Specified by:
toString
in interfaceJSON
- Parameters:
indentFactor
- The number of spaces to add to each level of indentation.indent
- The indentation of the top level.- Returns:
- a printable, displayable, transmittable representation of the
object, beginning with
{
(left brace) and ending with}
(right brace). - Throws:
JSONException
- If the object contains an invalid number.
-
isNullObject
public boolean isNullObject()Returs if this object is a null JSONObject. -
keys
Get an enumeration of the keys of the JSONObject.- Returns:
- An iterator of the keys.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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 coverted 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.
-
putAll
-
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.
-
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.
-
_accumulate
-
_processValue
- Overrides:
_processValue
in classAbstractJSON
-
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.- Specified by:
write
in classAbstractJSON
- Throws:
JSONException
IOException
-
_setInternal
Put a key/value pair in the JSONObject.- 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 JSONNull object.- Returns:
- this.
- Throws:
JSONException
- If the value is non-finite number or if the key is null.
-
processValue
-
processValue
-
setInternal
Put a key/value pair in the JSONObject.- 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 JSONNull object.- Returns:
- this.
- Throws:
JSONException
- If the value is non-finite number or if the key is null.
-
verifyIsNull
private void verifyIsNull()Checks if this object is a "null" object.
-