public class JSONObject extends java.lang.Object implements JSONElement
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.| Modifier and Type | Field and Description |
|---|---|
static java.lang.Object |
NULL
It is sometimes more convenient and less ambiguous to have a
NULL object than to use Java's null value. |
| Modifier | Constructor and Description |
|---|---|
|
JSONObject()
Construct an empty JSONObject.
|
protected |
JSONObject(int initialCapacity)
Constructor to specify an initial capacity of the internal map.
|
|
JSONObject(JSONObject jo,
java.lang.String[] names)
Construct a JSONObject from a subset of another JSONObject.
|
|
JSONObject(JSONTokener x)
Construct a JSONObject from a JSONTokener.
|
|
JSONObject(java.util.Map<?,?> m)
Construct a JSONObject from a Map.
|
|
JSONObject(java.lang.Object bean)
Construct a JSONObject from an Object using bean getters.
|
|
JSONObject(java.lang.Object object,
java.lang.String[] names)
Construct a JSONObject from an Object, using reflection to find the public members.
|
|
JSONObject(java.lang.String source)
Construct a JSONObject from a source JSON text string.
|
|
JSONObject(java.lang.String baseName,
java.util.Locale locale)
Construct a JSONObject from a ResourceBundle.
|
| Modifier and Type | Method and Description |
|---|---|
JSONObject |
accumulate(java.lang.String key,
java.lang.Object value)
Accumulate values under a key.
|
JSONObject |
add(java.lang.String key,
java.lang.Number value)
Add a number to a property.
|
JSONObject |
append(java.lang.String key,
java.lang.Object value)
Append values to the array under a key.
|
JSONObject |
clone()
Clone the element.
|
static JSONObject |
create()
Create a new JSONObject.
|
JSONObject |
decrement(java.lang.String key)
Decrement a property of a JSONObject.
|
static java.lang.String |
doubleToString(double d)
Produce a string from a double.
|
static java.lang.String |
doubleToString(double d,
boolean keepDecimalPoints)
Produce a string from a double.
|
protected java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> |
entrySet()
Get a set of entries of the JSONObject.
|
boolean |
equals(java.lang.Object o)
Returns true if this JSONObject is equal to another.
|
java.lang.Object |
get(java.lang.String key)
Get the value object associated with a key.
|
java.math.BigDecimal |
getBigDecimal(java.lang.String key)
Get the BigDecimal value associated with a key.
|
java.math.BigInteger |
getBigInteger(java.lang.String key)
Get the BigInteger value associated with a key.
|
boolean |
getBoolean(java.lang.String key)
Get the boolean value associated with a key.
|
double |
getDouble(java.lang.String key)
Get the double value associated with a key.
|
<E extends java.lang.Enum<E>> |
getEnum(java.lang.Class<E> clazz,
java.lang.String key)
Get the enum value associated with a key.
|
float |
getFloat(java.lang.String key)
Get the float value associated with a key.
|
int |
getInt(java.lang.String key)
Get the int value associated with a key.
|
JSONArray |
getJSONArray(java.lang.String key)
Get the JSONArray value associated with a key.
|
JSONObject |
getJSONObject(java.lang.String key)
Get the JSONObject value associated with a key.
|
long |
getLong(java.lang.String key)
Get the long value associated with a key.
|
static java.lang.String[] |
getNames(JSONObject jo)
Get an array of field names from a JSONObject.
|
static java.lang.String[] |
getNames(java.lang.Object object)
Get an array of field names from an Object.
|
java.lang.Number |
getNumber(java.lang.String key)
Get the Number value associated with a key.
|
java.lang.String |
getString(java.lang.String key)
Get the string associated with a key.
|
boolean |
has(java.lang.String key)
Determine if the JSONObject contains a specific key.
|
int |
hashCode() |
JSONObject |
increment(java.lang.String key)
Increment a property of a JSONObject.
|
protected static boolean |
isDecimalNotation(java.lang.String val)
Tests if the value should be tried as a decimal.
|
boolean |
isEmpty()
Check if JSONObject is empty.
|
boolean |
isNull(java.lang.String key)
Determine if the value associated with the key is
null or if there is no value. |
java.util.Iterator<java.lang.String> |
keys()
Get an enumeration of the keys of the JSONObject.
|
java.util.Set<java.lang.String> |
keySet()
Get a set of keys of the JSONObject.
|
int |
length()
Get the number of keys stored in the JSONObject.
|
JSONArray |
names()
Produce a JSONArray containing the names of the elements of this JSONObject.
|
static java.lang.String |
numberToString(java.lang.Number number)
Produce a string from a Number.
|
static java.lang.String |
numberToString(java.lang.Number number,
boolean keepDecimalPoints)
Produce a string from a Number.
|
java.lang.Object |
opt(java.lang.String key)
Get an optional value associated with a key.
|
java.math.BigDecimal |
optBigDecimal(java.lang.String key,
java.math.BigDecimal defaultValue)
Get an optional BigDecimal associated with a key, or the defaultValue if there is no such key or if its value is not a number.
|
java.math.BigInteger |
optBigInteger(java.lang.String key,
java.math.BigInteger defaultValue)
Get an optional BigInteger associated with a key, or the defaultValue if there is no such key or if its value is not a number.
|
boolean |
optBoolean(java.lang.String key)
Get an optional boolean associated with a key.
|
boolean |
optBoolean(java.lang.String key,
boolean defaultValue)
Get an optional boolean associated with a key.
|
double |
optDouble(java.lang.String key)
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 |
optDouble(java.lang.String key,
double defaultValue)
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.
|
<E extends java.lang.Enum<E>> |
optEnum(java.lang.Class<E> clazz,
java.lang.String key)
Get the enum value associated with a key.
|
<E extends java.lang.Enum<E>> |
optEnum(java.lang.Class<E> clazz,
java.lang.String key,
E defaultValue)
Get the enum value associated with a key.
|
float |
optFloat(java.lang.String key)
Get the optional double value associated with an index.
|
float |
optFloat(java.lang.String key,
float defaultValue)
Get the optional double value associated with an index.
|
int |
optInt(java.lang.String key)
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 |
optInt(java.lang.String key,
int defaultValue)
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.
|
JSONArray |
optJSONArray(java.lang.String key)
Get an optional JSONArray associated with a key.
|
JSONObject |
optJSONObject(java.lang.String key)
Get an optional JSONObject associated with a key.
|
long |
optLong(java.lang.String key)
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 |
optLong(java.lang.String key,
long defaultValue)
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.
|
java.lang.Number |
optNumber(java.lang.String key)
Get an optional
Number value associated with a key, or null if there is no such key or if the value is not a number. |
java.lang.Number |
optNumber(java.lang.String key,
java.lang.Number defaultValue)
Get an optional
Number value associated with a key, or the default if there is no such key or if the value is not a number. |
java.lang.Object |
optQuery(JSONPointer jsonPointer)
Queries and returns a value from this object using
jsonPointer, or returns null if the query fails due to a missing key. |
java.lang.Object |
optQuery(java.lang.String jsonPointer)
Queries and returns a value from this object using
jsonPointer, or returns null if the query fails due to a missing key. |
java.lang.String |
optString(java.lang.String key)
Get an optional string associated with a key.
|
java.lang.String |
optString(java.lang.String key,
java.lang.String defaultValue)
Get an optional string associated with a key.
|
JSONObject |
put(java.lang.String key,
boolean value)
Put a key/boolean pair in the JSONObject.
|
JSONObject |
put(java.lang.String key,
java.util.Collection<?> value)
Put a key/value pair in the JSONObject, where the value will be a JSONArray which is produced from a Collection.
|
JSONObject |
put(java.lang.String key,
double value)
Put a key/double pair in the JSONObject.
|
JSONObject |
put(java.lang.String key,
float value)
Put a key/float pair in the JSONObject.
|
JSONObject |
put(java.lang.String key,
int value)
Put a key/int pair in the JSONObject.
|
JSONObject |
put(java.lang.String key,
long value)
Put a key/long pair in the JSONObject.
|
JSONObject |
put(java.lang.String key,
java.util.Map<?,?> value)
Put a key/value pair in the JSONObject, where the value will be a JSONObject which is produced from a Map.
|
JSONObject |
put(java.lang.String key,
java.lang.Object value)
Put a key/value pair in the JSONObject.
|
JSONObject |
putNULL(java.lang.String key)
Put a key/NULL object pair in the JSONObject.
|
JSONObject |
putOnce(java.lang.String key,
java.lang.Object value)
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.
|
JSONObject |
putOpt(java.lang.String key,
java.lang.Object value)
Put a key/value pair in the JSONObject, but only if the key and the value are both non-null.
|
java.lang.Object |
query(JSONPointer jsonPointer)
Uses a user initialized JSONPointer and tries to match it to an item within this JSONObject.
|
java.lang.Object |
query(java.lang.String jsonPointer)
Creates a JSONPointer using an initialization string and tries to match it to an item within this JSONObject.
|
static java.lang.String |
quote(java.lang.String string)
Produce a string in double quotes with backslash sequences in all the right places.
|
static java.io.Writer |
quote(java.lang.String string,
java.io.Writer w) |
java.lang.Object |
remove(java.lang.String key)
Remove a name and its value, if present.
|
boolean |
similar(java.lang.Object other)
Determine if two JSONObjects are similar.
|
protected static java.lang.Number |
stringToNumber(java.lang.String val)
Converts a string to a number using the narrowest possible type.
|
static java.lang.Object |
stringToValue(java.lang.String string)
Try to convert a string into a number, boolean, or null.
|
JSONObject |
substract(java.lang.String key,
java.lang.Number value)
Substract a number to a property.
|
static void |
testValidity(java.lang.Object o)
Throw an exception if the object is a NaN or infinite number.
|
JSONArray |
toJSONArray(JSONArray names)
Produce a JSONArray containing the values of the members of this JSONObject.
|
java.util.Map<java.lang.String,java.lang.Object> |
toMap()
Returns a java.util.Map containing all of the entries in this object.
|
java.lang.String |
toString()
Make a JSON text of this JSONObject.
|
java.lang.String |
toString(int indentFactor)
Make a pretty-printed JSON text of this JSONObject.
|
java.util.Collection<java.lang.Object> |
values()
Get a collection of values of the JSONObject
|
static java.lang.String |
valueToString(java.lang.Object value)
Make a JSON text of an Object value.
|
static java.lang.Object |
wrap(java.lang.Object object)
Wrap an object, if necessary.
|
java.io.Writer |
write(java.io.Writer writer)
Write the contents of the JSONObject as JSON text to a writer.
|
java.io.Writer |
write(java.io.Writer writer,
int indent)
Write the contents of the JSONObject as JSON text to a writer, without keeping the keys natural order.
|
java.io.Writer |
write(java.io.Writer writer,
int indent,
boolean isValue,
JSONOptions options)
Write the contents of the JSONObject as JSON text to a writer.
|
finalize, getClass, notify, notifyAll, wait, wait, waitfromString, writepublic static final java.lang.Object NULL
NULL object than to use Java's null value.
JSONObject.NULL.equals(null) returns true. JSONObject.NULL.toString() returns "null".public JSONObject()
public JSONObject(JSONObject jo, java.lang.String[] names)
jo - A JSONObjectnames - An array of stringspublic JSONObject(JSONTokener x) throws JSONException
x - A JSONTokener object containing the source stringJSONException - If there is a syntax error in the source string or a duplicated keypublic JSONObject(java.util.Map<?,?> m)
m - A map object that can be used to initialize the contents of the JSONObject.JSONException - If a value in the map is non-finite number.java.lang.NullPointerException - If a key in the map is nullpublic JSONObject(java.lang.Object bean)
"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 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 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 JSONPropertyIgnore annotation can be used to force the bean property to not be serialized into JSON. If both
JSONPropertyIgnore and 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 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; }
bean - An object that has getter methods that should be used to make a JSONObject.public JSONObject(java.lang.Object object,
java.lang.String[] names)
object - An object that has fields that should be used to make a JSONObject.names - An array of strings, the names of the fields to be obtained from the object.public JSONObject(java.lang.String source)
throws JSONException
source - A string beginning with { (left brace) and ending with } (right
brace).JSONException - If there is a syntax error in the source string or a duplicated key.public JSONObject(java.lang.String baseName,
java.util.Locale locale)
throws JSONException
baseName - The ResourceBundle base namelocale - The Locale to load the ResourceBundle forJSONException - If any JSONExceptions are detectedprotected JSONObject(int initialCapacity)
initialCapacity - initial capacity of the internal map.public static JSONObject create()
public JSONObject clone()
JSONElementclone in interface JSONElementclone in class java.lang.Objectpublic boolean equals(java.lang.Object o)
equals in class java.lang.Objecto - the other objectpublic int hashCode()
hashCode in class java.lang.Objectpublic JSONObject accumulate(java.lang.String key, java.lang.Object value) throws JSONException
key - A key string.value - An object to be accumulated under the key.JSONException - If the value is non-finite number.java.lang.NullPointerException - If the key is null.public JSONObject append(java.lang.String key, java.lang.Object value) throws JSONException
key - A key stringvalue - An object to be accumulated under the keyJSONException - If the value is non-finite number or if the current value associated with the key is not a JSONArray.java.lang.NullPointerException - If the key is nullpublic static java.lang.String doubleToString(double d)
d - A doublepublic static java.lang.String doubleToString(double d,
boolean keepDecimalPoints)
d - A doublekeepDecimalPoints - if decimal points must be kept in numberspublic java.lang.Object get(java.lang.String key)
throws JSONException
key - A key stringJSONException - if the key is not foundpublic <E extends java.lang.Enum<E>> E getEnum(java.lang.Class<E> clazz,
java.lang.String key)
throws JSONException
E - the enum classclazz - The type of enum to retrievekey - A key stringJSONException - if the key is not found or if the value cannot be converted to an enumpublic boolean getBoolean(java.lang.String key)
throws JSONException
key - A key stringJSONException - if the value is not a Boolean or the String "true" or "false"public java.math.BigInteger getBigInteger(java.lang.String key)
throws JSONException
key - A key stringJSONException - if the key is not found or if the value cannot be converted to BigIntegerpublic java.math.BigDecimal getBigDecimal(java.lang.String key)
throws JSONException
key - A key stringJSONException - if the key is not found or if the value cannot be converted to BigDecimalpublic double getDouble(java.lang.String key)
throws JSONException
key - A key stringJSONException - if the key is not found or if the value is not a Number object and cannot be converted to a numberpublic float getFloat(java.lang.String key)
throws JSONException
key - A key stringJSONException - if the key is not found or if the value is not a Number object and cannot be converted to a numberpublic java.lang.Number getNumber(java.lang.String key)
throws JSONException
key - A key stringJSONException - if the key is not found or if the value is not a Number object and cannot be converted to a numberpublic int getInt(java.lang.String key)
throws JSONException
key - A key stringJSONException - if the key is not found or if the value cannot be converted to an integerpublic JSONArray getJSONArray(java.lang.String key) throws JSONException
key - A key stringJSONException - if the key is not found or if the value is not a JSONArraypublic JSONObject getJSONObject(java.lang.String key) throws JSONException
key - A key stringJSONException - if the key is not found or if the value is not a JSONObjectpublic long getLong(java.lang.String key)
throws JSONException
key - A key stringJSONException - if the key is not found or if the value cannot be converted to a longpublic static java.lang.String[] getNames(JSONObject jo)
jo - the JSONObjectpublic static java.lang.String[] getNames(java.lang.Object object)
object - the Objectpublic java.lang.String getString(java.lang.String key)
throws JSONException
key - A key stringJSONException - if there is no string value for the keypublic boolean has(java.lang.String key)
key - A key stringpublic JSONObject increment(java.lang.String key) throws JSONException
key - A key stringJSONException - If there is already a property with this name that is not an Integer, Long, Double, or Floatpublic JSONObject decrement(java.lang.String key) throws JSONException
key - A key stringJSONException - If there is already a property with this name that is not an Integer, Long, Double, or Floatpublic JSONObject add(java.lang.String key, java.lang.Number value) throws JSONException
key - the property keyvalue - the number to addJSONException - if the property is not a numberpublic JSONObject substract(java.lang.String key, java.lang.Number value) throws JSONException
key - the property keyvalue - the number to substractJSONException - if the property is not a numberpublic boolean isNull(java.lang.String key)
null or if there is no value.key - A key stringpublic java.util.Iterator<java.lang.String> keys()
Set.iterator()public java.util.Set<java.lang.String> keySet()
public java.util.Collection<java.lang.Object> values()
protected java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> entrySet()
public int length()
length in interface JSONElementpublic boolean isEmpty()
isEmpty in interface JSONElementpublic JSONArray names()
public static java.lang.String numberToString(java.lang.Number number)
throws JSONException
number - A NumberJSONException - If n is a non-finite numberpublic static java.lang.String numberToString(java.lang.Number number,
boolean keepDecimalPoints)
throws JSONException
number - A NumberkeepDecimalPoints - if decimal points must be kept in numbersJSONException - If n is a non-finite numberpublic java.lang.Object opt(java.lang.String key)
key - A key string.public <E extends java.lang.Enum<E>> E optEnum(java.lang.Class<E> clazz,
java.lang.String key)
E - The enum type subclassclazz - The type of enum to retrieve.key - A key string.public <E extends java.lang.Enum<E>> E optEnum(java.lang.Class<E> clazz,
java.lang.String key,
E defaultValue)
E - The enum type subclassclazz - The type of enum to retrieve.key - A key string.defaultValue - The default in case the value is not foundclazzpublic boolean optBoolean(java.lang.String key)
key - A key string.public boolean optBoolean(java.lang.String key,
boolean defaultValue)
key - A key string.defaultValue - The default.public java.math.BigDecimal optBigDecimal(java.lang.String key,
java.math.BigDecimal defaultValue)
key - A key string.defaultValue - The default.public java.math.BigInteger optBigInteger(java.lang.String key,
java.math.BigInteger defaultValue)
key - A key string.defaultValue - The default.public double optDouble(java.lang.String key)
key - A string which is the key.public double optDouble(java.lang.String key,
double defaultValue)
key - A key string.defaultValue - The default.public float optFloat(java.lang.String key)
key - A key string.public float optFloat(java.lang.String key,
float defaultValue)
key - A key string.defaultValue - The default value.public int optInt(java.lang.String key)
key - A key string.public int optInt(java.lang.String key,
int defaultValue)
key - A key string.defaultValue - The default.public JSONArray optJSONArray(java.lang.String key)
key - A key string.public JSONObject optJSONObject(java.lang.String key)
key - A key string.public long optLong(java.lang.String key)
key - A key string.public long optLong(java.lang.String key,
long defaultValue)
key - A key string.defaultValue - The default.public java.lang.Number optNumber(java.lang.String key)
Number value associated with a key, or 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 (BigDecimal). This method would be used in cases where type
coercion of the number value is unwanted.key - A key string.public java.lang.Number optNumber(java.lang.String key,
java.lang.Number defaultValue)
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.key - A key string.defaultValue - The default.public java.lang.String optString(java.lang.String key)
key - A key string.public java.lang.String optString(java.lang.String key,
java.lang.String defaultValue)
key - A key string.defaultValue - The default.public JSONObject put(java.lang.String key, boolean value) throws JSONException
key - A key stringvalue - A boolean which is the valueJSONException - If the value is non-finite numberjava.lang.NullPointerException - If the key is nullpublic JSONObject put(java.lang.String key, java.util.Collection<?> value) throws JSONException
key - A key stringvalue - A Collection valueJSONException - If the value is non-finite numberjava.lang.NullPointerException - If the key is nullpublic JSONObject put(java.lang.String key, double value) throws JSONException
key - A key stringvalue - A double which is the valueJSONException - If the value is non-finite numberjava.lang.NullPointerException - If the key is nullpublic JSONObject put(java.lang.String key, float value) throws JSONException
key - A key stringvalue - A float which is the valueJSONException - If the value is non-finite number.java.lang.NullPointerException - If the key is null.public JSONObject put(java.lang.String key, int value) throws JSONException
key - A key string.value - An int which is the value.JSONException - If the value is non-finite number.java.lang.NullPointerException - If the key is null.public JSONObject putNULL(java.lang.String key) throws JSONException
key - A key stringJSONException - If the value is non-finite numberjava.lang.NullPointerException - If the key is nullpublic JSONObject put(java.lang.String key, long value) throws JSONException
key - A key string.value - A long which is the value.JSONException - If the value is non-finite number.java.lang.NullPointerException - If the key is null.public JSONObject put(java.lang.String key, java.util.Map<?,?> value) throws JSONException
key - A key string.value - A Map value.JSONException - If the value is non-finite number.java.lang.NullPointerException - If the key is null.public JSONObject put(java.lang.String key, java.lang.Object value) throws JSONException
null, then the key will be removed from the JSONObject if it is present.key - A key string.value - An object which is the value. It should be of one of these types: Boolean, Double, Integer, JSONArray, JSONObject, Long, String, or
the JSONObject.NULL object.JSONException - If the value is non-finite number.java.lang.NullPointerException - If the key is null.public JSONObject putOnce(java.lang.String key, java.lang.Object value) throws JSONException
key - stringvalue - objectJSONException - if the key is a duplicatepublic JSONObject putOpt(java.lang.String key, java.lang.Object value) throws JSONException
key - A key string.value - An object which is the value. It should be of one of these types: Boolean, Double, Integer, JSONArray, JSONObject, Long, String, or
the JSONObject.NULL object.JSONException - If the value is a non-finite number.public java.lang.Object query(java.lang.String jsonPointer)
{
"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.
query in interface JSONElementjsonPointer - string that can be used to create a JSONPointerpublic java.lang.Object query(JSONPointer jsonPointer)
{
"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.
query in interface JSONElementjsonPointer - string that can be used to create a JSONPointerpublic java.lang.Object optQuery(java.lang.String jsonPointer)
jsonPointer, or returns null if the query fails due to a missing key.jsonPointer - the string representation of the JSON pointernulljava.lang.IllegalArgumentException - if jsonPointer has invalid syntaxpublic java.lang.Object optQuery(JSONPointer jsonPointer)
jsonPointer, or returns null if the query fails due to a missing key.jsonPointer - The JSON pointernulljava.lang.IllegalArgumentException - if jsonPointer has invalid syntaxpublic static java.lang.String quote(java.lang.String string)
string - A Stringpublic static java.io.Writer quote(java.lang.String string,
java.io.Writer w)
throws java.io.IOException
java.io.IOExceptionpublic java.lang.Object remove(java.lang.String key)
key - The name to be removed.public boolean similar(java.lang.Object other)
other - The other JSONObjectprotected static boolean isDecimalNotation(java.lang.String val)
val - value to testprotected static java.lang.Number stringToNumber(java.lang.String val)
throws java.lang.NumberFormatException
val - value to convertjava.lang.NumberFormatException - thrown if the value is not a valid number. A public caller should catch this and wrap it in a
JSONException if applicable.public static java.lang.Object stringToValue(java.lang.String string)
string - A String.public static void testValidity(java.lang.Object o)
throws JSONException
o - The object to test.JSONException - If o is a non-finite number.public JSONArray toJSONArray(JSONArray names) throws JSONException
names - A JSONArray containing a list of key strings. This determines the sequence of the values in the result.JSONException - If any of the values are non-finite numbers.public java.lang.String toString()
Warning: This method assumes that the data structure is acyclical.
toString in class java.lang.Object{ (left
brace) and ending with } (right brace).public java.lang.String toString(int indentFactor)
throws JSONException
If indentFactor > 0 and the JSONObject has only one key, then the object will be output on a single line:
{"key": 1}
If an object has 2 or more keys, then it will be output across multiple lines: {
"key1": 1,
"key2": "value 2",
"key3": 3
}
Warning: This method assumes that the data structure is acyclical.
toString in interface JSONElementindentFactor - The number of spaces to add to each level of indentation.{ (left
brace) and ending with } (right brace).JSONException - If the object contains an invalid number.public static java.lang.String valueToString(java.lang.Object value)
throws JSONException
Warning: This method assumes that the data structure is acyclical.
value - The value to be serialized.{ (left brace) and
ending with } (right brace).JSONException - If the value is or contains an invalid number.public static java.lang.Object wrap(java.lang.Object object)
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.object - The object to wrappublic java.io.Writer write(java.io.Writer writer)
throws JSONException
Warning: This method assumes that the data structure is acyclical.
write in interface JSONElementwriter - the writerJSONExceptionpublic java.io.Writer write(java.io.Writer writer,
int indent)
throws JSONException
write in interface JSONElementwriter - Writes the serialized JSONindent - The indentation of the top levelJSONException - if the JSONObject was unable to writepublic java.io.Writer write(java.io.Writer writer,
int indent,
boolean isValue,
JSONOptions options)
throws JSONException
If indentFactor > 0 and the JSONObject has only one key, then the object will be output on a single line:
{"key": 1}
If an object has 2 or more keys, then it will be output across multiple lines: {
"key1": 1,
"key2": "value 2",
"key3": 3
}
Warning: This method assumes that the data structure is acyclical.
write in interface JSONElementwriter - Writes the serialized JSONindent - The indentation of the top levelisValue - true to write a valueoptions - the JSON configuration optionsJSONException - if the JSONObject was unable to writepublic java.util.Map<java.lang.String,java.lang.Object> toMap()
Warning: This method assumes that the data structure is acyclical.
Copyright (C) 2017 Wei Song. Copyright (c) 2002 JSON.org. Copyright © 2018, 2019, 2026 Herve Girod. All Rights Reserved. elasticlunr Documentation and source under the MIT licence. JSON Documentation and source under the JSON licence