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 coersion 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 sysntax 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.
- 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) or
0x- (hex) prefix.
- Comments written in the slashshlash, slashstar, and hash conventions
will be ignored.
Creates a JSONObject.
Inspects the object type to call the correct JSONObject factory method.
- Parameters:
object- Throws:
JSONException if the object can not be converted to a proper
JSONObject.
Creates a JSONObject.
Inspects the object type to call the correct JSONObject factory method.
- Parameters:
object- Throws:
JSONException if the object can not be converted to a proper
JSONObject.
if( object == null || JSONUtils.isNull( object ) ){ }else if( object instanceof Enum ){ throw new JSONException( "'object' is an Enum. Use JSONArray instead" );
}else if( object instanceof Map ){ }else if( object instanceof String ){ }else if( JSONUtils.isArray( object ) ){ throw new JSONException( "'object' is an array. Use JSONArray instead" );
Creates a JSONDynaBean from a JSONObject.
if( !JSONUtils.isNull( value ) ){ dynaBean.set( key, value );
log.warn( "Tried to assign null value to " + key + ":" + type.getName() );
dynaBean.set( key, null );
throw new JSONException( "Error while setting property=" + name + " type" + type, e );
return toBean(this,beanClass);
Creates a bean from a JSONObject, with a specific target class.
return toBean( jsonObject, jsonConfig );
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.
return toBean( jsonObject, jsonConfig );
Creates a bean from a JSONObject, with the specific configuration.
throw new JSONException( "beanClass is an interface. " + beanClass );
return toBean(jsonObject,bean,jsonConfig);
Creates a bean from a JSONObject, with the specific configuration.
if( jsonObject == null || jsonObject.isNullObject() || bean == null ){ throw new JSONException( "Root bean is an interface. " + rootClass );
if( javaPropertyFilter != null && javaPropertyFilter.apply( bean, name, value ) ){ log.warn( "Property '" + pd.name() + "' has no write method. SKIPPED." );
if( !JSONUtils.isNull( value ) ){ if( innerType==Object.class && targetInnerType != null
&& targetInnerType!=Object.class ){ innerType = targetInnerType;
log.warn( "Can't transform property '" + pd.name() + "' from "
.getName() + ". Will register a default BeanMorpher" );
}else if(bean instanceof Map ){ + " to bean of class " + bean.getClass()
newTargetClass = newTargetClass == null ? findTargetClass( name, classMap )
if( targetClass == Object.class ){ }else if( bean instanceof Map ){ if( targetClass != null ){ + " to bean of class " + bean.getClass()
throw new JSONException( "Error while setting property=" + name + " type " + type, e );
Creates a JSONObject from a POJO.
Supports nested maps, POJOs, and arrays/collections.
- Parameters:
bean An object with POJO conventions- Throws:
JSONException if the bean can not be converted to a proper
JSONObject.
for( int i = 0; i < pds.length; i++ ){ if( jsonPropertyFilter != null && jsonPropertyFilter.apply( bean, key, value ) ){ if( jsonValueProcessor != null ){ throw new JSONException( "Value is not a valid JSON value. " + value );
setValue( jsonObject, key, value, type, jsonConfig );
String warning = "Property '" + key + "' has no read method. SKIPPED";
if( jsonPropertyFilter != null && jsonPropertyFilter.apply( bean, key, value )) continue;
if( jsonValueProcessor != null ){ throw new JSONException( "Value is not a valid JSON value. " + value );
setValue( jsonObject, key, value, type, jsonConfig );
for( int i = 0; i < props.length; i++ ){ if( jsonPropertyFilter != null && jsonPropertyFilter.apply( bean, key, value ) ){ if( jsonValueProcessor != null ){ throw new JSONException( "Value is not a valid JSON value. " + value );
setValue( jsonObject, key, value, type, jsonConfig );
if( jsonPropertyFilter != null && jsonPropertyFilter.apply( object, key, value ) ){ throw tokener.syntaxError( "A JSONObject text must begin with '{'" ); throw tokener.syntaxError( "A JSONObject text must end with '}'" );
if( tokener.next() != '>' ){ throw tokener.syntaxError( "Expected a ':' after a key" );
if( jsonPropertyFilter == null || !jsonPropertyFilter.apply( tokener, key, v ) ){ jsonObject.element( key, value, jsonConfig );
jsonObject.element( key, v, jsonConfig );
char ch = tokener.next();
throw tokener.syntaxError( "Unbalanced '{' or '}' on prop: " + v ); (params != null) ? StringUtils.split( params, "," ) : null, text );
if( jsonPropertyFilter == null || !jsonPropertyFilter.apply( tokener, key, value ) ){ jsonObject.element( key, value, jsonConfig );
if( jsonPropertyFilter != null && jsonPropertyFilter.apply( map, key, value ) ){ if( jsonValueProcessor != null ){ throw new JSONException( "Value is not a valid JSON value. " + value );
Locates a Class associated to a specifi key.
The key may be a regexp.
if( targetClass == null ){ boolean accumulated = false;
jsonObject.properties.put( key, value );
value = jsonObject.opt( key );
value = array.get( array.size() - 1 );
identifies this object as null
The Map where the JSONObject's properties are kept.
Construct an empty JSONObject.
Creates a JSONObject that is null.
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 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 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 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 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 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.
int size2 = other.size();
}else if( size1 > size2 ){ }else if( this.equals( other ) ){ 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.
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
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
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.
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.
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.
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
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
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.
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.
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.
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.
if( key != null && value != null ){ }else if( o2 instanceof String ){ if( m1 != null && m1 != IdentityObjectMorpher.getInstance() ){ }else if( m2 != null && m2 != IdentityObjectMorpher.getInstance() ){ 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.
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".
throw new JSONException( "JSONObject[" + JSONUtils.quote( key ) + "] is not a Boolean." );
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.
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.
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.
throw new JSONException( "JSONObject[" + JSONUtils.quote( key ) + "] is not a JSONArray." );
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.
throw new JSONException( "JSONObject[" + JSONUtils.quote( key ) + "] is not a JSONObject." );
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.
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.
Determine if the JSONObject contains a specific key.
- Parameters:
key A key string.- Returns:
- true if the key exists in the JSONObject.
Returs if this object is a null JSONObject.
Get an enumeration of the keys of the JSONObject.
- Returns:
- An iterator of the keys.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
return o != null ? o.toString() : defaultValue;
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.
Get the number of keys stored in the JSONObject.
- Returns:
- The number of keys in the JSONObject.
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.
if( names == null || names.size() == 0 ){ for( int i = 0; i < names.size(); i += 1 ){ 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.
- Returns:
- a printable, displayable, portable, transmittable representation
of the object, beginning with
{Â (left
brace) and ending with }Â (right
brace).
Make a prettyprinted JSON text of this JSONObject.
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.
Make a prettyprinted JSON text of this JSONObject.
Warning: This method assumes that the data structure is acyclical.
- 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.
int newindent = indent + indentFactor;
for( i = 0; i < newindent; i += 1 ){ for( i = 0; i < indent; i += 1 ){ for( i = 0; i < indent; i += 1 ){ 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.
.element( value, jsonConfig ), jsonConfig );
|| value instanceof Class ){ }else if( value instanceof JSON ){ return JSONSerializer.toJSON( value, jsonConfig );
if( value instanceof String ){ return JSONSerializer.toJSON(value, jsonConfig );
}else if( JSONUtils.isArray( value ) ){ }else if( JSONUtils.isString( value ) ){ }else if( JSONUtils.isNumber( value ) ){ 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.
throw new JSONException( "Value is not a valid JSON value. " + value );
throw new JSONException( "Value is not a valid JSON value. " + value );
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.
Checks if this object is a "null" object.