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:
*
, (comma) may appear just
* before the closing brace.' (single
* quote).{ } [ ] / \ : , # and if they do not look like numbers and if
* they are not the reserved words true, false, or
* null.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()
{
// HashMap is used on purpose to ensure that elements are unordered by
// the specification.
// JSON tends to be a portable transfer format to allows the container
// implementations to rearrange their items for a faster element
// retrieval based on associative access.
// Therefore, an implementation mustn't rely on the order of the item.
this.map = new HashMapnull
*/
public JSONObject(Map m)
{
if (m == null)
{
this.map = new HashMap"get" or "is"
* followed by an uppercase letter, the method is invoked, and a key and the
* value returned from the getter method are put into the new JSONObject.
*
* The key is formed by removing the "get" or "is"
* prefix. If the second remaining character is not upper case, then the first
* character is converted to lower case.
*
* Methods that are static, return void, have
* parameters, or are "bridge" methods, are ignored.
*
* For example, if an object has a method named "getName", and if
* the result of calling object.getName() is
* "Larry Fine", then the JSONObject will contain
* "name": "Larry Fine".
*
* The {@link JSONPropertyName} annotation can be used on a bean getter to
* override key name used in the JSONObject. For example, using the object
* above with the getName method, if we annotated it with:
*
*
* @JSONPropertyName("FullName")
* public String getName()
* {
* return this.name;
* }
*
*
* The resulting JSON object would contain
* "FullName": "Larry Fine"
*
* Similarly, the {@link JSONPropertyName} annotation can be used on non-
* get and is methods. We can also override key name
* used in the JSONObject as seen below even though the field would normally
* be ignored:
*
*
* @JSONPropertyName("FullName")
* public String fullName()
* {
* return this.name;
* }
*
*
* The resulting JSON object would contain
* "FullName": "Larry Fine"
*
* The {@link JSONPropertyIgnore} annotation can be used to force the bean
* property to not be serialized into JSON. If both {@link JSONPropertyIgnore}
* and {@link JSONPropertyName} are defined on the same method, a depth
* comparison is performed and the one closest to the concrete class being
* serialized is used. If both annotations are at the same level, then the
* {@link JSONPropertyIgnore} annotation takes precedent and the field is not
* serialized. For example, the following declaration would prevent the
* getName method from being serialized:
*
*
* @JSONPropertyName("FullName")
* @JSONPropertyIgnore
* public String getName()
* {
* return this.name;
* }
*
*
*
* @param bean
* An object that has getter methods that should be used to make a
* JSONObject.
*/
public JSONObject(Object bean)
{
this();
this.populateMap(bean);
}
/**
* 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.
*
* @param object
* An object that has fields that should be used to make a
* JSONObject.
* @param names
* An array of strings, the names of the fields to be obtained from
* the object.
*/
public JSONObject(Object object, String names[])
{
this(names.length);
Class c = object.getClass();
for (int i = 0; i < names.length; i += 1)
{
String name = names[i];
try
{
this.putOpt(name, c.getField(name).get(object));
} catch (Exception ignore)
{
}
}
}
/**
* Construct a JSONObject from a source JSON text string. This is the most
* commonly used JSONObject constructor.
*
* @param source
* A string beginning with
* Warning: This method assumes that the data structure is acyclical.
*
* @return a printable, displayable, portable, transmittable representation of
* the object, beginning with
* If
* If an object has 2 or more keys, then it will be output across multiple
* lines:
* Warning: This method assumes that the data structure is acyclical.
*
* @param indentFactor
* The number of spaces to add to each level of indentation.
* @return a printable, displayable, portable, transmittable representation of
* the object, beginning with
* Warning: This method assumes that the data structure is acyclical.
*
* @param value
* The value to be serialized.
* @return a printable, displayable, transmittable representation of the
* object, beginning with
* Warning: This method assumes that the data structure is acyclical.
*
* @return The writer.
* @throws JSONException
*/
public Writer write(Writer writer) throws JSONException
{
return this.write(writer, 0, 0);
}
static final Writer writeValue(Writer writer, Object value,
int indentFactor, int indent) throws JSONException, IOException
{
if (value == null || value.equals(null))
{
writer.write("null");
}
else if (value instanceof JSONString)
{
Object o;
try
{
o = ((JSONString) value).toJSONString();
} catch (Exception e)
{
throw new JSONException(e);
}
writer.write(o != null ? o.toString() : quote(value.toString()));
}
else if (value instanceof Number)
{
// not all Numbers may match actual JSON Numbers. i.e. fractions or
// Imaginary
final String numberAsString = numberToString((Number) value);
try
{
// Use the BigDecimal constructor for its parser to validate the format.
@SuppressWarnings("unused")
BigDecimal testNum = new BigDecimal(numberAsString);
// Close enough to a JSON number that we will use it unquoted
writer.write(numberAsString);
} catch (NumberFormatException ex)
{
// The Number value is not a valid JSON number.
// Instead we will quote it as a string
quote(numberAsString, writer);
}
}
else if (value instanceof Boolean)
{
writer.write(value.toString());
}
else if (value instanceof Enum)
{
writer.write(quote(((Enum) value).name()));
}
else if (value instanceof JSONObject)
{
((JSONObject) value).write(writer, indentFactor, indent);
}
else if (value instanceof JSONArray)
{
((JSONArray) value).write(writer, indentFactor, indent);
}
else if (value instanceof Map)
{
Map map = (Map) value;
new JSONObject(map).write(writer, indentFactor, indent);
}
else if (value instanceof Collection)
{
Collection coll = (Collection) value;
new JSONArray(coll).write(writer, indentFactor, indent);
}
else if (value.getClass().isArray())
{
new JSONArray(value).write(writer, indentFactor, indent);
}
else
{
quote(value.toString(), writer);
}
return writer;
}
static final void indent(Writer writer, int indent) throws IOException
{
for (int i = 0; i < indent; i += 1)
{
writer.write(' ');
}
}
/**
* Write the contents of the JSONObject as JSON text to a writer.
*
*
* If
* If an object has 2 or more keys, then it will be output across multiple
* lines:
* Warning: This method assumes that the data structure is acyclical.
*
* @param writer
* Writes the serialized JSON
* @param indentFactor
* The number of spaces to add to each level of indentation.
* @param indent
* The indentation of the top level.
* @return The writer.
* @throws JSONException
*/
public Writer write(Writer writer, int indentFactor, int indent)
throws JSONException
{
try
{
boolean commanate = false;
final int length = this.length();
writer.write('{');
if (length == 1)
{
final Entry
* Warning: This method assumes that the data structure is acyclical.
*
* @return a java.util.Map containing the entries of this object
*/
public Map{ (left
* brace) and ending with } (right
* brace).
* @exception JSONException
* If there is a syntax error in the source string or a
* duplicated key.
*/
public JSONObject(String source) throws JSONException
{
this(new JSONTokener(source));
}
/**
* Construct a JSONObject from a ResourceBundle.
*
* @param baseName
* The ResourceBundle base name.
* @param locale
* The Locale to load the ResourceBundle for.
* @throws JSONException
* If any JSONExceptions are detected.
*/
public JSONObject(String baseName, Locale locale) throws JSONException
{
this();
ResourceBundle bundle = ResourceBundle.getBundle(baseName, locale,
Thread.currentThread().getContextClassLoader());
// Iterate through the keys in the bundle.
Enumerationnull.
*/
public JSONObject accumulate(String key, Object value)
throws JSONException
{
testValidity(value);
Object object = this.opt(key);
if (object == null)
{
this.put(key, value instanceof JSONArray ? new JSONArray().put(value)
: value);
}
else if (object instanceof JSONArray)
{
((JSONArray) object).put(value);
}
else
{
this.put(key, new JSONArray().put(object).put(value));
}
return this;
}
/**
* 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.
*
* @param key
* A key string.
* @param value
* An object to be accumulated under the key.
* @return this.
* @throws JSONException
* If the value is non-finite number or if the current value
* associated with the key is not a JSONArray.
* @throws NullPointerException
* If the key is null.
*/
public JSONObject append(String key, Object value) throws JSONException
{
testValidity(value);
Object object = this.opt(key);
if (object == null)
{
this.put(key, new JSONArray().put(value));
}
else if (object instanceof JSONArray)
{
this.put(key, ((JSONArray) object).put(value));
}
else
{
throw new JSONException(
"JSONObject[" + key + "] is not a JSONArray.");
}
return this;
}
/**
* Produce a string from a double. The string "null" will be returned if the
* number is not finite.
*
* @param d
* A double.
* @return A String.
*/
public static String doubleToString(double d)
{
if (Double.isInfinite(d) || Double.isNaN(d))
{
return "null";
}
// Shave off trailing zeros and decimal point, if possible.
String string = Double.toString(d);
if (string.indexOf('.') > 0 && string.indexOf('e') < 0
&& string.indexOf('E') < 0)
{
while (string.endsWith("0"))
{
string = string.substring(0, string.length() - 1);
}
if (string.endsWith("."))
{
string = string.substring(0, string.length() - 1);
}
}
return string;
}
/**
* 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
{
if (key == null)
{
throw new JSONException("Null key.");
}
Object object = this.opt(key);
if (object == null)
{
throw new JSONException("JSONObject[" + quote(key) + "] not found.");
}
return object;
}
/**
* Get the enum value associated with a key.
*
* @param clazz
* The type of enum to retrieve.
* @param key
* A key string.
* @return 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.
*/
public 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(this.opt(key));
}
/**
* Get an enumeration of the keys of the JSONObject. Modifying this key Set
* will also modify the JSONObject. Use with caution.
*
* @see Set#iterator()
*
* @return An iterator of the keys.
*/
public Iteratorclazz
*/
public null if there is no such key or if the value is not a number.
* If the value is a string, an attempt will be made to evaluate it as a
* number ({@link BigDecimal}). This method would be used in cases where type
* coercion of the number value is unwanted.
*
* @param key
* A key string.
* @return An object which is the value.
*/
public Number optNumber(String key)
{
return this.optNumber(key, null);
}
/**
* Get an optional {@link Number} value associated with a key, or the default
* if there is no such key or if the value is not a number. If the value is a
* string, an attempt will be made to evaluate it as a number. This method
* would be used in cases where type coercion of the number value is unwanted.
*
* @param key
* A key string.
* @param defaultValue
* The default.
* @return An object which is the value.
*/
public Number optNumber(String key, Number defaultValue)
{
Object val = this.opt(key);
if (NULL.equals(val))
{
return defaultValue;
}
if (val instanceof Number)
{
return (Number) val;
}
if (val instanceof String)
{
try
{
return stringToNumber((String) val);
} catch (Exception e)
{
return defaultValue;
}
}
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 converted to a string.
*
* @param key
* A key string.
* @return A string which is the value.
*/
public String optString(String key)
{
return this.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 object = this.opt(key);
return NULL.equals(object) ? defaultValue : object.toString();
}
/**
* Populates the internal map of the JSONObject with the bean properties. The
* bean can not be recursive.
*
* @see JSONObject#JSONObject(Object)
*
* @param bean
* the bean
*/
private void populateMap(Object bean)
{
Class klass = bean.getClass();
// If klass is a System class then set includeSuperClass to false.
boolean includeSuperClass = klass.getClassLoader() != null;
Method[] methods = includeSuperClass ? klass.getMethods()
: klass.getDeclaredMethods();
for (final Method method : methods)
{
final int modifiers = method.getModifiers();
if (Modifier.isPublic(modifiers) && !Modifier.isStatic(modifiers)
&& method.getParameterTypes().length == 0
&& !method.isBridge() && method.getReturnType() != Void.TYPE
&& isValidMethodName(method.getName()))
{
final String key = getKeyNameFromMethod(method);
if (key != null && !key.isEmpty())
{
try
{
final Object result = method.invoke(bean);
if (result != null)
{
this.map.put(key, wrap(result));
// we don't use the result anywhere outside of wrap
// if it's a resource we should be sure to close it
// after calling toString
if (result instanceof Closeable)
{
try
{
((Closeable) result).close();
} catch (IOException ignore)
{
}
}
}
} catch (IllegalAccessException ignore)
{
} catch (IllegalArgumentException ignore)
{
} catch (InvocationTargetException ignore)
{
}
}
}
}
}
private boolean isValidMethodName(String name)
{
return !"getClass".equals(name) && !"getDeclaringClass".equals(name);
}
private String getKeyNameFromMethod(Method method)
{
final int ignoreDepth = -1;// getAnnotationDepth(method,
// JSONPropertyIgnore.class);
// if (ignoreDepth > 0) {
// final int forcedNameDepth = getAnnotationDepth(method,
// JSONPropertyName.class);
// if (forcedNameDepth < 0 || ignoreDepth <= forcedNameDepth) {
// // the hierarchy asked to ignore, and the nearest name override
// // was higher or non-existent
// return null;
// }
// }
// JSONPropertyName annotation = getAnnotation(method,
// JSONPropertyName.class);
// if (annotation != null && annotation.value() != null &&
// !annotation.value().isEmpty()) {
// return annotation.value();
// }
String key;
final String name = method.getName();
if (name.startsWith("get") && name.length() > 3)
{
key = name.substring(3);
}
else if (name.startsWith("is") && name.length() > 2)
{
key = name.substring(2);
}
else
{
return null;
}
// if the first letter in the key is not uppercase, then skip.
// This is to maintain backwards compatibility before PR406
// (https://github.com/stleary/JSON-java/pull/406/)
if (Character.isLowerCase(key.charAt(0)))
{
return null;
}
if (key.length() == 1)
{
key = key.toLowerCase(Locale.ROOT);
}
else if (!Character.isUpperCase(key.charAt(1)))
{
key = key.substring(0, 1).toLowerCase(Locale.ROOT) + key.substring(1);
}
return (/** @j2sNative 1 ? key.split("$")[0] : */
key);
}
// /**
// * Searches the class hierarchy to see if the method or it's super
// * implementations and interfaces has the annotation.
// *
// * @param
// * type of the annotation
// *
// * @param m
// * method to check
// * @param annotationClass
// * annotation to look for
// * @return the {@link Annotation} if the annotation exists on the current
// method
// * or one of it's super class definitions
// */
// private static A getAnnotation(final Method m, final
// Class annotationClass) {
// return null;
// // if we have invalid data the result is null
// if (true || m == null || annotationClass == null) {
// return null;
// }
//
// if (m.isAnnotationPresent(annotationClass)) {
// return m.getAnnotation(annotationClass);
// }
//
// // if we've already reached the Object class, return null;
// Class c = m.getDeclaringClass();
// if (c.getSuperclass() == null) {
// return null;
// }
//
// // check directly implemented interfaces for the method being checked
// for (Class i : c.getInterfaces()) {
// try {
// Method im = i.getMethod(m.getName(), m.getParameterTypes());
// return getAnnotation(im, annotationClass);
// } catch (final SecurityException ex) {
// continue;
// } catch (final NoSuchMethodException ex) {
// continue;
// }
// }
//
// try {
// return getAnnotation(
// c.getSuperclass().getMethod(m.getName(), m.getParameterTypes()),
// annotationClass);
// } catch (final SecurityException ex) {
// return null;
// } catch (final NoSuchMethodException ex) {
// return null;
// }
// }
//
// /**
// * 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.
// *
// * @param
// * type of the annotation
// *
// * @param m
// * method to check
// * @param annotationClass
// * annotation to look for
// * @return Depth of the annotation or -1 if the annotation is not on the
// method.
// */
// private static int getAnnotationDepth(final Method m, final Class annotationClass) {
// // if we have invalid data the result is -1
// if (m == null || annotationClass == null) {
// return -1;
// }
// if (m.isAnnotationPresent(annotationClass)) {
// return 1;
// }
//
// // if we've already reached the Object class, return -1;
// Class c = m.getDeclaringClass();
// if (c.getSuperclass() == null) {
// return -1;
// }
//
// // check directly implemented interfaces for the method being checked
// for (Class i : c.getInterfaces()) {
// try {
// Method im = i.getMethod(m.getName(), m.getParameterTypes());
// int d = getAnnotationDepth(im, annotationClass);
// if (d > 0) {
// // since the annotation was on the interface, add 1
// return d + 1;
// }
// } catch (final SecurityException ex) {
// continue;
// } catch (final NoSuchMethodException ex) {
// continue;
// }
// }
//
// try {
// int d = getAnnotationDepth(
// c.getSuperclass().getMethod(m.getName(), m.getParameterTypes()),
// annotationClass);
// if (d > 0) {
// // since the annotation was on the superclass, add 1
// return d + 1;
// }
// return -1;
// } catch (final SecurityException ex) {
// return -1;
// } catch (final NoSuchMethodException ex) {
// return -1;
// }
// }
/**
* 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 value is non-finite number.
* @throws NullPointerException
* If the key is null.
*/
public JSONObject put(String key, boolean value) throws JSONException
{
return this.put(key, value ? Boolean.TRUE : Boolean.FALSE);
}
/**
* Put a key/value pair in the JSONObject, where the value will be a JSONArray
* which is produced from a Collection.
*
* @param key
* A key string.
* @param value
* A Collection value.
* @return this.
* @throws JSONException
* If the value is non-finite number.
* @throws NullPointerException
* If the key is null.
*/
public JSONObject put(String key, Collection value)
throws JSONException
{
return this.put(key, new JSONArray(value));
}
/**
* 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 value is non-finite number.
* @throws NullPointerException
* If the key is null.
*/
public JSONObject put(String key, double value) throws JSONException
{
return this.put(key, Double.valueOf(value));
}
/**
* Put a key/float pair in the JSONObject.
*
* @param key
* A key string.
* @param value
* A float which is the value.
* @return this.
* @throws JSONException
* If the value is non-finite number.
* @throws NullPointerException
* If the key is null.
*/
public JSONObject put(String key, float value) throws JSONException
{
return this.put(key, Float.valueOf(value));
}
/**
* 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 value is non-finite number.
* @throws NullPointerException
* If the key is null.
*/
public JSONObject put(String key, int value) throws JSONException
{
return this.put(key, Integer.valueOf(value));
}
/**
* 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 value is non-finite number.
* @throws NullPointerException
* If the key is null.
*/
public JSONObject put(String key, long value) throws JSONException
{
return this.put(key, Long.valueOf(value));
}
/**
* Put a key/value pair in the JSONObject, where the value will be a
* JSONObject which is produced from a Map.
*
* @param key
* A key string.
* @param value
* A Map value.
* @return this.
* @throws JSONException
* If the value is non-finite number.
* @throws NullPointerException
* If the key is null.
*/
public JSONObject put(String key, Map value) throws JSONException
{
return this.put(key, new JSONObject(value));
}
/**
* 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.
* @throws NullPointerException
* If the key is null.
*/
public JSONObject put(String key, Object value) throws JSONException
{
if (key == null)
{
throw new NullPointerException("Null key.");
}
if (value != null)
{
testValidity(value);
this.map.put(key, value);
}
else
{
this.remove(key);
}
return this;
}
/**
* 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.
*
* @param key
* string
* @param value
* object
* @return this.
* @throws JSONException
* if the key is a duplicate
*/
public JSONObject putOnce(String key, Object value) throws JSONException
{
if (key != null && value != null)
{
if (this.opt(key) != null)
{
throw new JSONException("Duplicate key \"" + key + "\"");
}
return this.put(key, value);
}
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)
{
return this.put(key, value);
}
return this;
}
/**
* 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.
*
* @param jsonPointer
* string that can be used to create a JSONPointer
* @return the item matched by the JSONPointer, otherwise null
*/
public Object query(String jsonPointer)
{
return query(new JSONPointer(jsonPointer));
}
/**
* Uses a user initialized JSONPointer and tries to match it to an item within
* this JSONObject. For example, given a JSONObject initialized with this
* document:
*
*
* {
* "a":{"b":"c"}
* }
*
*
* and this JSONPointer:
*
*
* "/a/b"
*
*
* Then this method will return the String "c". A JSONPointerException may be
* thrown from code called by this method.
*
* @param jsonPointer
* string that can be used to create a JSONPointer
* @return the item matched by the JSONPointer, otherwise null
*/
public Object query(JSONPointer jsonPointer)
{
return jsonPointer.queryFrom(this);
}
/**
* Queries and returns a value from this object using {@code jsonPointer}, or
* returns null if the query fails due to a missing key.
*
* @param jsonPointer
* the string representation of the JSON pointer
* @return the queried value or {@code null}
* @throws IllegalArgumentException
* if {@code jsonPointer} has invalid syntax
*/
public Object optQuery(String jsonPointer)
{
return optQuery(new JSONPointer(jsonPointer));
}
/**
* Queries and returns a value from this object using {@code jsonPointer}, or
* returns null if the query fails due to a missing key.
*
* @param jsonPointer
* The JSON pointer
* @return the queried value or {@code null}
* @throws IllegalArgumentException
* if {@code jsonPointer} has invalid syntax
*/
public Object optQuery(JSONPointer jsonPointer)
{
try
{
return jsonPointer.queryFrom(this);
} catch (JSONPointerException e)
{
return null;
}
}
/**
* Produce a string in double quotes with backslash sequences in all the right
* places. A backslash will be inserted within = '\u0080' && c < '\u00a0')
|| (c >= '\u2000' && c < '\u2100'))
{
w.write("\\u");
hhhh = Integer.toHexString(c);
w.write("0000", 0, 4 - hhhh.length());
w.write(hhhh);
}
else
{
w.write(c);
}
}
}
w.write('"');
return w;
}
/**
* 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.map.remove(key);
}
/**
* Determine if two JSONObjects are similar. They must contain the same set of
* names which must be associated with similar values.
*
* @param other
* The other JSONObject
* @return true if they are equal
*/
public boolean similar(Object other)
{
try
{
if (!(other instanceof JSONObject))
{
return false;
}
if (!this.keySet().equals(((JSONObject) other).keySet()))
{
return false;
}
for (final Entry{ (left
* brace) and ending with } (right
* brace).
*/
@Override
public String toString()
{
try
{
return this.toString(0);
} catch (Exception e)
{
return null;
}
}
/**
* Make a pretty-printed JSON text of this JSONObject.
*
* indentFactor > 0 and the {@link JSONObject} has only one
* key, then the object will be output on a single line:
*
*
* {@code {"key": 1}}
*
*
* {
* "key1": 1,
* "key2": "value 2",
* "key3": 3
* }{ (left
* brace) and ending with } (right
* brace).
* @throws JSONException
* If the object contains an invalid number.
*/
public String toString(int indentFactor) throws JSONException
{
StringWriter w = new StringWriter();
synchronized (w.getBuffer())
{
return this.write(w, indentFactor, 0).toString();
}
}
/**
* 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.
*
* { (left
* brace) and ending with } (right
* brace).
* @throws JSONException
* If the value is or contains an invalid number.
*/
public static String valueToString(Object value) throws JSONException
{
// moves the implementation to JSONWriter as:
// 1. It makes more sense to be part of the writer class
// 2. For Android support this method is not available. By implementing it
// in
// the Writer
// Android users can use the writer with the built in Android JSONObject
// implementation.
return JSONWriter.valueToString(value);
}
/**
* Wrap an object, if necessary. If the object is null, return
* the NULL object. If it is an array or collection, wrap it in a JSONArray.
* If it is a map, wrap it in a JSONObject. If it is a standard property
* (Double, String, et al) then it is already wrapped. Otherwise, if it comes
* from one of the java packages, turn it into a string. And if it doesn't,
* try to wrap it in a JSONObject. If the wrapping fails, then null is
* returned.
*
* @param object
* The object to wrap
* @return The wrapped value
*/
public static Object wrap(Object object)
{
try
{
if (object == null)
{
return NULL;
}
if (object instanceof JSONObject || object instanceof JSONArray
|| NULL.equals(object) || object instanceof JSONString
|| object instanceof Byte || object instanceof Character
|| object instanceof Short || object instanceof Integer
|| object instanceof Long || object instanceof Boolean
|| object instanceof Float || object instanceof Double
|| object instanceof String || object instanceof BigInteger
|| object instanceof BigDecimal || object instanceof Enum)
{
return object;
}
if (object instanceof Collection)
{
Collection coll = (Collection) object;
return new JSONArray(coll);
}
if (object.getClass().isArray())
{
return new JSONArray(object);
}
if (object instanceof Map)
{
Map map = (Map) object;
return new JSONObject(map);
}
Package objectPackage = object.getClass().getPackage();
String objectPackageName = objectPackage != null
? objectPackage.getName()
: "";
if (objectPackageName.startsWith("java.")
|| objectPackageName.startsWith("javax.")
|| object.getClass().getClassLoader() == null)
{
return object.toString();
}
return new JSONObject(object);
} catch (Exception exception)
{
return null;
}
}
/**
* Write the contents of the JSONObject as JSON text to a writer. For
* compactness, no whitespace is added.
* indentFactor > 0 and the {@link JSONObject} has only one
* key, then the object will be output on a single line:
*
*
* {@code {"key": 1}}
*
*
* {
* "key1": 1,
* "key2": "value 2",
* "key3": 3
* }