net.sourceforge.jweb.json.JSONObject Maven / Gradle / Ivy
Show all versions of jweb-common Show documentation
package net.sourceforge.jweb.json;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.Map;
/**
* A JSONObject is an unordered collection of name/value pairs. Its external
* form is a string wrapped in curly braces with colons between the names and
* values, and commas between the values and names. The internal form is an
* object having get
and opt
methods for accessing the
* values by name, and put
methods for adding or replacing values
* by name. The values can be any of these types: Boolean
,
* JSONArray
, JSONObject
, Number
,
* String
, or the JSONObject.NULL
object. A JSONObject
* constructor can be used to convert an external form JSON text into an
* internal form whose values can be retrieved with the get
and
* opt
methods, or to convert values into a JSON text using the
* put
and toString
methods. A get
method
* returns a value if one can be found, and throws an exception if one cannot be
* found. An opt
method returns a default value instead of throwing
* an exception, and so is useful for obtaining optional values.
*
* The generic get()
and opt()
methods return an
* object, which you can cast or query for type. There are also typed
* get
and opt
methods that do type checking and type
* 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.
*
*
* @author JSON.org
* @version 2
*/
public class JSONObject extends JSONElement {
private boolean asPrimary;
/**
* JSONObject.NULL is equivalent to the value that JavaScript calls null, whilst
* Java's null is equivalent to the value that JavaScript calls undefined.
*/
private static final class Null {
/**
* There is only intended to be a single instance of the NULL object, so the
* clone method returns itself.
*
* @return NULL.
*/
protected final Object clone() {
return this;
}
/**
* A Null object is equal to the null value and to itself.
*
* @param object
* An object to test for nullness.
* @return true if the object parameter is the JSONObject.NULL object or null.
*/
public boolean equals(Object object) {
return object == null || object == this;
}
public int hashCode() {
return 1;
}
/**
* Get the "null" string value.
*
* @return The string "null".
*/
public String toString() {
return "null";
}
}
/**
* The hash map where the JSONObject's properties are kept.
*/
private HashMap myHashMap;
/**
* It is sometimes more convenient and less ambiguous to have a
* NULL
object than to use Java's null
value.
* JSONObject.NULL.equals(null)
returns true
.
* JSONObject.NULL.toString()
returns "null"
.
*/
public static final Object NULL = new Null();
/**
* Construct an empty JSONObject.
*/
public JSONObject() {
this.myHashMap = new LinkedHashMap();
}
/**
* 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.
*
* @param jo
* A JSONObject.
* @param sa
* An array of strings.
* @exception JSONException
* If a value is a non-finite number.
*/
public JSONObject(JSONObject jo, String[] sa) throws JSONException {
this();
for (int i = 0; i < sa.length; i += 1) {
putOpt(sa[i], jo.opt(sa[i]));
}
}
/**
* Construct a JSONObject from a JSONTokener.
*
* @param x
* A JSONTokener object containing the source string.
* @throws JSONException
* If there is a syntax error in the source string.
*/
public JSONObject(JSONTokener x) throws JSONException {
this();
char c;
String key;
if (x.nextClean() != '{') {
throw x.syntaxError("A JSONObject text must begin with '{'");
}
for (;;) {
c = x.nextClean();
switch (c) {
case 0:
throw x.syntaxError("A JSONObject text must end with '}'");
case '}':
return;
default:
x.back();
key = x.nextValue().toString();
}
/*
* The key is followed by ':'. We will also tolerate '=' or '=>'.
*/
c = x.nextClean();
if (c == '=') {
if (x.next() != '>') {
x.back();
}
} else if (c != ':') {
throw x.syntaxError("Expected a ':' after a key");
}
this.myHashMap.put(key, x.nextValue());
/*
* Pairs are separated by ','. We will also tolerate ';'.
*/
switch (x.nextClean()) {
case ';':
case ',':
if (x.nextClean() == '}') {
return;
}
x.back();
break;
case '}':
return;
default:
throw x.syntaxError("Expected a ',' or '}'");
}
}
}
/**
* Construct a JSONObject from a Map.
*
* @param map
* A map object that can be used to initialize the contents of the
* JSONObject.
*/
public JSONObject(Map map) {
this.myHashMap = new HashMap(map);
}
/**
* Construct a JSONObject from a string. This is the most commonly used
* JSONObject constructor.
*
* @param string
* A string beginning with {
(left
* brace) and ending with }
(right
* brace).
* @exception JSONException
* If there is a syntax error in the source string.
*/
public JSONObject(String string) throws JSONException {
this(new JSONTokener(string));
}
/**
* 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.
*
* @param key
* A key string.
* @param value
* An object to be accumulated under the key.
* @return this.
* @throws JSONException
* If the value is an invalid number or if the key is null.
*/
public JSONObject accumulate(String key, Object value) throws JSONException {
testValidity(value);
Object o = opt(key);
if (o == null) {
put(key, value);
} else if (o instanceof JSONArray) {
((JSONArray) o).put(value);
} else {
put(key, new JSONArray().put(o).put(value));
}
return this;
}
/**
* Get the value object associated with a key.
*
* @param key
* A key string.
* @return The object associated with the key.
* @throws JSONException
* if the key is not found.
*/
public Object get(String key) throws JSONException {
Object o = opt(key);
if (o == null) {
throw new JSONException("JSONObject[" + (key) + "] not found.");
}
return o;
}
/**
* Get the boolean value associated with a key.
*
* @param key
* A key string.
* @return The truth.
* @throws JSONException
* if the value is not a Boolean or the String "true" or "false".
*/
public boolean getBoolean(String key) throws JSONException {
Object o = get(key);
if (o.equals(Boolean.FALSE) || (o instanceof String && ((String) o).equalsIgnoreCase("false"))) {
return false;
} else if (o.equals(Boolean.TRUE) || (o instanceof String && ((String) o).equalsIgnoreCase("true"))) {
return true;
}
throw new JSONException("JSONObject[" + (key) + "] is not a Boolean.");
}
/**
* Get the double value associated with a key.
*
* @param key
* A key string.
* @return 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.
*/
public double getDouble(String key) throws JSONException {
Object o = get(key);
try {
return o instanceof Number ? ((Number) o).doubleValue() : Double.parseDouble((String) o);
} catch (Exception e) {
throw new JSONException("JSONObject[" + (key) + "] is not a number.");
}
}
/**
* Get the int value associated with a key. If the number value is too large for
* an int, it will be clipped.
*
* @param key
* A key string.
* @return The integer value.
* @throws JSONException
* if the key is not found or if the value cannot be converted to an
* integer.
*/
public int getInt(String key) throws JSONException {
Object o = get(key);
return o instanceof Number ? ((Number) o).intValue() : (int) getDouble(key);
}
/**
* Get the JSONArray value associated with a key.
*
* @param key
* A key string.
* @return A JSONArray which is the value.
* @throws JSONException
* if the key is not found or if the value is not a JSONArray.
*/
public JSONArray getJSONArray(String key) throws JSONException {
Object o = get(key);
if (o instanceof JSONArray) {
return (JSONArray) o;
}
throw new JSONException("JSONObject[" + (key) + "] is not a JSONArray.");
}
/**
* Get the JSONObject value associated with a key.
*
* @param key
* A key string.
* @return A JSONObject which is the value.
* @throws JSONException
* if the key is not found or if the value is not a JSONObject.
*/
public JSONObject getJSONObject(String key) throws JSONException {
Object o = get(key);
if (o instanceof JSONObject) {
return (JSONObject) o;
}
throw new JSONException("JSONObject[" + (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.
*
* @param key
* A key string.
* @return The long value.
* @throws JSONException
* if the key is not found or if the value cannot be converted to a
* long.
*/
public long getLong(String key) throws JSONException {
Object o = get(key);
return o instanceof Number ? ((Number) o).longValue() : (long) getDouble(key);
}
/**
* Get the string associated with a key.
*
* @param key
* A key string.
* @return A string which is the value.
* @throws JSONException
* if the key is not found.
*/
public String getString(String key) throws JSONException {
return get(key).toString();
}
/**
* Determine if the JSONObject contains a specific key.
*
* @param key
* A key string.
* @return true if the key exists in the JSONObject.
*/
public boolean has(String key) {
return this.myHashMap.containsKey(key);
}
/**
* Determine if the value associated with the key is null or if there is no
* value.
*
* @param key
* A key string.
* @return true if there is no value associated with the key or if the value is
* the JSONObject.NULL object.
*/
public boolean isNull(String key) {
return JSONObject.NULL.equals(opt(key));
}
/**
* Get an enumeration of the keys of the JSONObject.
*
* @return An iterator of the keys.
*/
public Iterator keys() {
return this.myHashMap.keySet().iterator();
}
/**
* Get the number of keys stored in the JSONObject.
*
* @return The number of keys in the JSONObject.
*/
public int length() {
return this.myHashMap.size();
}
/**
* Produce a JSONArray containing the names of the elements of this JSONObject.
*
* @return A JSONArray containing the key strings, or null if the JSONObject is
* empty.
*/
public JSONArray names() {
JSONArray ja = new JSONArray();
Iterator keys = keys();
while (keys.hasNext()) {
ja.put(keys.next());
}
return ja.length() == 0 ? null : ja;
}
/**
* Produce a string from a number.
*
* @param n
* A Number
* @return A String.
* @throws JSONException
* If n is a non-finite number.
*/
static public String numberToString(Number n) throws JSONException {
if (n == null) {
throw new JSONException("Null pointer");
}
testValidity(n);
// Shave off trailing zeros and decimal point, if possible.
String s = n.toString();
if (s.indexOf('.') > 0 && s.indexOf('e') < 0 && s.indexOf('E') < 0) {
while (s.endsWith("0")) {
s = s.substring(0, s.length() - 1);
}
if (s.endsWith(".")) {
s = s.substring(0, s.length() - 1);
}
}
return s;
}
/**
* Get an optional value associated with a key.
*
* @param key
* A key string.
* @return An object which is the value, or null if there is no value.
*/
public Object opt(String key) {
return key == null ? null : this.myHashMap.get(key);
}
/**
* Get an optional boolean associated with a key. It returns false if there is
* no such key, or if the value is not Boolean.TRUE or the String "true".
*
* @param key
* A key string.
* @return The truth.
*/
public boolean optBoolean(String key) {
return optBoolean(key, false);
}
/**
* 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).
*
* @param key
* A key string.
* @param defaultValue
* The default.
* @return The truth.
*/
public boolean optBoolean(String key, boolean defaultValue) {
try {
return getBoolean(key);
} catch (Exception e) {
return defaultValue;
}
}
/**
* 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.
*
* @param key
* A string which is the key.
* @return An object which is the value.
*/
public double optDouble(String key) {
return optDouble(key, Double.NaN);
}
/**
* 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.
*
* @param key
* A key string.
* @param defaultValue
* The default.
* @return An object which is the value.
*/
public double optDouble(String key, double defaultValue) {
try {
Object o = opt(key);
return o instanceof Number ? ((Number) o).doubleValue() : new Double((String) o).doubleValue();
} catch (Exception e) {
return defaultValue;
}
}
/**
* 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.
*
* @param key
* A key string.
* @return An object which is the value.
*/
public int optInt(String key) {
return optInt(key, 0);
}
/**
* 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.
*
* @param key
* A key string.
* @param defaultValue
* The default.
* @return An object which is the value.
*/
public int optInt(String key, int defaultValue) {
try {
return getInt(key);
} catch (Exception e) {
return defaultValue;
}
}
/**
* 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.
*
* @param key
* A key string.
* @return A JSONArray which is the value.
*/
public JSONArray optJSONArray(String key) {
Object o = opt(key);
return o instanceof JSONArray ? (JSONArray) o : null;
}
/**
* 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.
*
* @param key
* A key string.
* @return A JSONObject which is the value.
*/
public JSONObject optJSONObject(String key) {
Object o = opt(key);
return o instanceof JSONObject ? (JSONObject) o : null;
}
/**
* 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.
*
* @param key
* A key string.
* @return An object which is the value.
*/
public long optLong(String key) {
return optLong(key, 0);
}
/**
* 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.
*
* @param key
* A key string.
* @param defaultValue
* The default.
* @return An object which is the value.
*/
public long optLong(String key, long defaultValue) {
try {
return getLong(key);
} catch (Exception e) {
return defaultValue;
}
}
/**
* 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.
*
* @param key
* A key string.
* @return A string which is the value.
*/
public String optString(String key) {
return optString(key, "");
}
/**
* Get an optional string associated with a key. It returns the defaultValue if
* there is no such key.
*
* @param key
* A key string.
* @param defaultValue
* The default.
* @return A string which is the value.
*/
public String optString(String key, String defaultValue) {
Object o = opt(key);
return o != null ? o.toString() : defaultValue;
}
/**
* Put a key/boolean pair in the JSONObject.
*
* @param key
* A key string.
* @param value
* A boolean which is the value.
* @return this.
* @throws JSONException
* If the key is null.
*/
public JSONObject put(String key, boolean value) throws JSONException {
put(key, value ? Boolean.TRUE : Boolean.FALSE);
return this;
}
/**
* Put a key/double pair in the JSONObject.
*
* @param key
* A key string.
* @param value
* A double which is the value.
* @return this.
* @throws JSONException
* If the key is null or if the number is invalid.
*/
public JSONObject put(String key, double value) throws JSONException {
put(key, new Double(value));
return this;
}
/**
* Put a key/int pair in the JSONObject.
*
* @param key
* A key string.
* @param value
* An int which is the value.
* @return this.
* @throws JSONException
* If the key is null.
*/
public JSONObject put(String key, int value) throws JSONException {
put(key, new Integer(value));
return this;
}
/**
* Put a key/long pair in the JSONObject.
*
* @param key
* A key string.
* @param value
* A long which is the value.
* @return this.
* @throws JSONException
* If the key is null.
*/
public JSONObject put(String key, long value) throws JSONException {
put(key, new Long(value));
return this;
}
/**
* 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.
*
* @param key
* A key string.
* @param 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.
* @return this.
* @throws JSONException
* If the value is non-finite number or if the key is null.
*/
public JSONObject put(String key, Object value) throws JSONException {
if (key == null) {
throw new JSONException("Null key.");
}
if (value != null) {
testValidity(value);
this.myHashMap.put(key, value);
} else {
remove(key);
}
return this;
}
/**
* Put a key/value pair in the JSONObject, but only if the key and the value are
* both non-null.
*
* @param key
* A key string.
* @param 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.
* @return this.
* @throws JSONException
* If the value is a non-finite number.
*/
public JSONObject putOpt(String key, Object value) throws JSONException {
if (key != null && value != null) {
put(key, value);
}
return this;
}
/**
* Remove a name and its value, if present.
*
* @param key
* The name to be removed.
* @return The value that was associated with the name, or null if there was no
* value.
*/
public Object remove(String key) {
return this.myHashMap.remove(key);
}
/**
* Throw an exception if the object is an NaN or infinite number.
*
* @param o
* The object to test.
* @throws JSONException
* If o is a non-finite number.
*/
static void testValidity(Object o) throws JSONException {
if (o != null) {
if (o instanceof Double) {
if (((Double) o).isInfinite() || ((Double) o).isNaN()) {
throw new JSONException("JSON does not allow non-finite numbers");
}
} else if (o instanceof Float) {
if (((Float) o).isInfinite() || ((Float) o).isNaN()) {
throw new JSONException("JSON does not allow non-finite numbers.");
}
}
}
}
/**
* Produce a JSONArray containing the values of the members of this JSONObject.
*
* @param names
* A JSONArray containing a list of key strings. This determines the
* sequence of the values in the result.
* @return A JSONArray of values.
* @throws JSONException
* If any of the values are non-finite numbers.
*/
public JSONArray toJSONArray(JSONArray names) throws JSONException {
if (names == null || names.length() == 0) {
return null;
}
JSONArray ja = new JSONArray();
for (int i = 0; i < names.length(); i += 1) {
ja.put(this.opt(names.getString(i)));
}
return ja;
}
/**
* Make an 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.
*
* @return a printable, displayable, portable, transmittable representation of
* the object, beginning with {
(left
* brace) and ending with }
(right
* brace).
*/
public String toString() {
try {
Iterator keys = keys();
StringBuffer sb = new StringBuffer("{");
while (keys.hasNext()) {
if (sb.length() > 1) {
sb.append(',');
}
Object o = keys.next();
sb.append(quote(o.toString(), this.isQuotoName() ? this.getQuotoString() : "", isStrict()));
sb.append(':');
Object entryValue = this.myHashMap.get(o);
if (entryValue instanceof String) {
sb.append(quote(entryValue.toString(), this.isQuotoValue() ? this.getQuotoString() : "", isStrict()));
} else {
sb.append(entryValue.toString());
}
}
sb.append('}');
return sb.toString();
} catch (Exception e) {
return null;
}
}
/**
* Test equality of 2 JSON objects. The objects are deemed to be equal if they
* contain the same properties
*
* @see java.lang.Object#equals(java.lang.Object)
*
* @param object
* The JSONObject with which to compare to
* @return true
if this JSONObject is the same as the object
* argument; false
otherwise.
*/
public boolean equals(Object object) {
if (object == null) {
return false;
}
JSONObject o = (JSONObject) object;
return (this.toHashMap().equals(o.toHashMap()));
}
/**
* Return a hashCode for the JSONObject. This returns the hashcode for the
* underlying HashMap
that stores the data
*
* @see java.lang.Object#hashCode()
*
* @return a hash code value for this object.
*/
public int hashCode() {
return this.toHashMap().hashCode();
}
/**
* Get the underlying hash map used to store this JSON Object data
*
* @return The underlying HashMap
object.
*/
public HashMap toHashMap() {
return this.myHashMap;
}
public final boolean isAsPrimary() {
return asPrimary;
}
public final void setAsPrimary(boolean asPrimary) {
this.asPrimary = asPrimary;
}
}