org.noear.solon.configurationprocessor.json

类 JSONObject

java.lang.Object

org.noear.solon.configurationprocessor.json.JSONObject

public class JSONObject
extends java.lang.Object

A modifiable set of name/value mappings. Names are unique, non-null strings. Values may be any mix of JSONObjects, JSONArrays, Strings, Booleans, Integers, Longs, Doubles or NULL. Values may not be null, NaNs, infinities, or of any type not listed here.

This class can coerce values to another type when requested.

• When the requested type is a boolean, strings will be coerced using a case-insensitive comparison to "true" and "false".
• When the requested type is a double, other Number types will be coerced using doubleValue. Strings that can be coerced using Double.valueOf(String) will be.
• When the requested type is an int, other Number types will be coerced using intValue. Strings that can be coerced using Double.valueOf(String) will be, and then cast to int.
• When the requested type is a long, other Number types will be coerced using longValue. Strings that can be coerced using Double.valueOf(String) will be, and then cast to long. This two-step conversion is lossy for very large values. For example, the string "9223372036854775806" yields the long 9223372036854775807.
• When the requested type is a String, other non-null values will be coerced using String.valueOf(Object). Although null cannot be coerced, the sentinel value NULL is coerced to the string "null".

This class can look up both mandatory and optional values:

• Use getType() to retrieve a mandatory value. This fails with a JSONException if the requested name has no value or if the value cannot be coerced to the requested type.
• Use optType() to retrieve an optional value. This returns a system- or user-supplied default if the requested name has no value or if the value cannot be coerced to the requested type.

Warning: this class represents null in two incompatible ways: the standard Java null reference, and the sentinel value NULL. In particular, calling put(name, null) removes the named entry from the object but put(name, JSONObject.NULL) stores an entry whose value is JSONObject.NULL.

Instances of this class are not thread safe. Although this class is nonfinal, it was not designed for inheritance and should not be subclassed. In particular, self-use by overrideable methods is not specified. See Effective Java Item 17, "Design and Document or inheritance or else prohibit it" for further information.

字段概要

字段

限定符和类型	字段和说明
static java.lang.Object	NULL A sentinel value used to explicitly define a name with no value.

构造器概要

构造器

构造器和说明
JSONObject() Creates a JSONObject with no name/value mappings.
JSONObject(JSONObject copyFrom, java.lang.String[] names) Creates a new JSONObject by copying mappings for the listed names from the given object.
JSONObject(JSONTokener readFrom) Creates a new JSONObject with name/value mappings from the next object in the tokener.
JSONObject(java.util.Map copyFrom) Creates a new JSONObject by copying all name/value mappings from the given map.
JSONObject(java.lang.String json) Creates a new JSONObject with name/value mappings from the JSON string.

方法概要

限定符和类型	方法和说明
JSONObject	accumulate(java.lang.String name, java.lang.Object value) Appends value to the array already mapped to name.
java.lang.Object	get(java.lang.String name) Returns the value mapped by name.
boolean	getBoolean(java.lang.String name) Returns the value mapped by name if it exists and is a boolean or can be coerced to a boolean.
double	getDouble(java.lang.String name) Returns the value mapped by name if it exists and is a double or can be coerced to a double.
int	getInt(java.lang.String name) Returns the value mapped by name if it exists and is an int or can be coerced to an int.
JSONArray	getJSONArray(java.lang.String name) Returns the value mapped by name if it exists and is a JSONArray.
JSONObject	getJSONObject(java.lang.String name) Returns the value mapped by name if it exists and is a JSONObject.
long	getLong(java.lang.String name) Returns the value mapped by name if it exists and is a long or can be coerced to a long.
java.lang.String	getString(java.lang.String name) Returns the value mapped by name if it exists, coercing it if necessary.
boolean	has(java.lang.String name) Returns true if this object has a mapping for name.
boolean	isNull(java.lang.String name) Returns true if this object has no mapping for name or if it has a mapping whose value is NULL.
java.util.Iterator	keys() Returns an iterator of the String names in this object.
int	length() Returns the number of name/value mappings in this object.
JSONArray	names() Returns an array containing the string names in this object.
static java.lang.String	numberToString(java.lang.Number number) Encodes the number as a JSON string.
java.lang.Object	opt(java.lang.String name) Returns the value mapped by name, or null if no such mapping exists.
boolean	optBoolean(java.lang.String name) Returns the value mapped by name if it exists and is a boolean or can be coerced to a boolean.
boolean	optBoolean(java.lang.String name, boolean fallback) Returns the value mapped by name if it exists and is a boolean or can be coerced to a boolean.
double	optDouble(java.lang.String name) Returns the value mapped by name if it exists and is a double or can be coerced to a double.
double	optDouble(java.lang.String name, double fallback) Returns the value mapped by name if it exists and is a double or can be coerced to a double.
int	optInt(java.lang.String name) Returns the value mapped by name if it exists and is an int or can be coerced to an int.
int	optInt(java.lang.String name, int fallback) Returns the value mapped by name if it exists and is an int or can be coerced to an int.
JSONArray	optJSONArray(java.lang.String name) Returns the value mapped by name if it exists and is a JSONArray.
JSONObject	optJSONObject(java.lang.String name) Returns the value mapped by name if it exists and is a JSONObject.
long	optLong(java.lang.String name) Returns the value mapped by name if it exists and is a long or can be coerced to a long.
long	optLong(java.lang.String name, long fallback) Returns the value mapped by name if it exists and is a long or can be coerced to a long.
java.lang.String	optString(java.lang.String name) Returns the value mapped by name if it exists, coercing it if necessary.
java.lang.String	optString(java.lang.String name, java.lang.String fallback) Returns the value mapped by name if it exists, coercing it if necessary.
JSONObject	put(java.lang.String name, boolean value) Maps name to value, clobbering any existing name/value mapping with the same name.
JSONObject	put(java.lang.String name, double value) Maps name to value, clobbering any existing name/value mapping with the same name.
JSONObject	put(java.lang.String name, int value) Maps name to value, clobbering any existing name/value mapping with the same name.
JSONObject	put(java.lang.String name, long value) Maps name to value, clobbering any existing name/value mapping with the same name.
JSONObject	put(java.lang.String name, java.lang.Object value) Maps name to value, clobbering any existing name/value mapping with the same name.
JSONObject	putOpt(java.lang.String name, java.lang.Object value) Equivalent to put(name, value) when both parameters are non-null; does nothing otherwise.
static java.lang.String	quote(java.lang.String data) Encodes data as a JSON string.
java.lang.Object	remove(java.lang.String name) Removes the named mapping if it exists; does nothing otherwise.
JSONArray	toJSONArray(JSONArray names) Returns an array with the values corresponding to names.
java.lang.String	toString() Encodes this object as a compact JSON string, such as: {"query":"Pizza","locations":[94043,90210]}
java.lang.String	toString(int indentSpaces) Encodes this object as a human-readable JSON string for debugging, such as: { "query": "Pizza", "locations": [ 94043, 90210 ] }
static java.lang.Object	wrap(java.lang.Object o) Wraps the given object if necessary.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

字段详细资料

NULL

public static final java.lang.Object NULL

A sentinel value used to explicitly define a name with no value. Unlike null, names with this value:

• show up in the names() array
• show up in the keys() iterator
• return true for has(String)
• do not throw on get(String)
• are included in the encoded JSON string.

This value violates the general contract of Object.equals(java.lang.Object) by returning true when compared to null. Its toString() method returns "null".

构造器详细资料

JSONObject

public JSONObject()

Creates a JSONObject with no name/value mappings.

JSONObject

public JSONObject(java.util.Map copyFrom)

Creates a new JSONObject by copying all name/value mappings from the given map.

参数:

copyFrom - a map whose keys are of type String and whose values are of supported types.

抛出:

java.lang.NullPointerException - if any of the map's keys are null.

JSONObject

public JSONObject(JSONTokener readFrom)
           throws JSONException

Creates a new JSONObject with name/value mappings from the next object in the tokener.

参数:

readFrom - a tokener whose nextValue() method will yield a JSONObject.

抛出:

JSONException - if the parse fails or doesn't yield a JSONObject.

JSONObject

public JSONObject(java.lang.String json)
           throws JSONException

Creates a new JSONObject with name/value mappings from the JSON string.

参数:

json - a JSON-encoded string containing an object.

抛出:

JSONException - if the parse fails or doesn't yield a JSONObject.

JSONObject

public JSONObject(JSONObject copyFrom,
                  java.lang.String[] names)
           throws JSONException

Creates a new JSONObject by copying mappings for the listed names from the given object. Names that aren't present in copyFrom will be skipped.

参数:

copyFrom - the source

names - the property names

抛出:

JSONException - if an error occurs

方法详细资料

length

public int length()

Returns the number of name/value mappings in this object.

返回:

the number of name/value mappings in this object

put

public JSONObject put(java.lang.String name,
                      boolean value)
               throws JSONException

Maps name to value, clobbering any existing name/value mapping with the same name.

参数:

name - the name of the property

value - the value of the property

返回:

this object.

抛出:

JSONException - if an error occurs

put

public JSONObject put(java.lang.String name,
                      double value)
               throws JSONException

Maps name to value, clobbering any existing name/value mapping with the same name.

参数:

name - the name of the property

value - a finite value. May not be NaNs or infinities.

返回:

this object.

抛出:

JSONException - if an error occurs

put

public JSONObject put(java.lang.String name,
                      int value)
               throws JSONException

Maps name to value, clobbering any existing name/value mapping with the same name.

参数:

name - the name of the property

value - the value of the property

返回:

this object.

抛出:

JSONException - if an error occurs

put

public JSONObject put(java.lang.String name,
                      long value)
               throws JSONException

Maps name to value, clobbering any existing name/value mapping with the same name.

参数:

name - the name of the property

value - the value of the property

返回:

this object.

抛出:

JSONException - if an error occurs

put

public JSONObject put(java.lang.String name,
                      java.lang.Object value)
               throws JSONException

Maps name to value, clobbering any existing name/value mapping with the same name. If the value is null, any existing mapping for name is removed.

参数:

name - the name of the property

value - a JSONObject, JSONArray, String, Boolean, Integer, Long, Double, NULL, or null. May not be NaNs or infinities.

返回:

this object.

抛出:

JSONException - if an error occurs

putOpt

public JSONObject putOpt(java.lang.String name,
                         java.lang.Object value)
                  throws JSONException

Equivalent to put(name, value) when both parameters are non-null; does nothing otherwise.

参数:

name - the name of the property

value - the value of the property

返回:

this object.

抛出:

JSONException - if an error occurs

accumulate

public JSONObject accumulate(java.lang.String name,
                             java.lang.Object value)
                      throws JSONException

Appends value to the array already mapped to name. If this object has no mapping for name, this inserts a new mapping. If the mapping exists but its value is not an array, the existing and new values are inserted in order into a new array which is itself mapped to name. In aggregate, this allows values to be added to a mapping one at a time.

参数:

name - the name of the property

value - a JSONObject, JSONArray, String, Boolean, Integer, Long, Double, NULL or null. May not be NaNs or infinities.

返回:

this object.

抛出:

JSONException - if an error occurs

remove

public java.lang.Object remove(java.lang.String name)

Removes the named mapping if it exists; does nothing otherwise.

参数:

name - the name of the property

返回:

the value previously mapped by name, or null if there was no such mapping.

isNull

public boolean isNull(java.lang.String name)

Returns true if this object has no mapping for name or if it has a mapping whose value is NULL.

参数:

name - the name of the property

返回:

true if this object has no mapping for name

has

public boolean has(java.lang.String name)

Returns true if this object has a mapping for name. The mapping may be NULL.

参数:

name - the name of the property

返回:

true if this object has a mapping for name

get

public java.lang.Object get(java.lang.String name)
                     throws JSONException

Returns the value mapped by name.

参数:

name - the name of the property

返回:

the value

抛出:

JSONException - if no such mapping exists.

opt

public java.lang.Object opt(java.lang.String name)

Returns the value mapped by name, or null if no such mapping exists.

参数:

name - the name of the property

返回:

the value or null

getBoolean

public boolean getBoolean(java.lang.String name)
                   throws JSONException

Returns the value mapped by name if it exists and is a boolean or can be coerced to a boolean.

参数:

name - the name of the property

返回:

the value

抛出:

JSONException - if the mapping doesn't exist or cannot be coerced to a boolean.

optBoolean

public boolean optBoolean(java.lang.String name)

Returns the value mapped by name if it exists and is a boolean or can be coerced to a boolean. Returns false otherwise.

参数:

name - the name of the property

返回:

the value or null

optBoolean

public boolean optBoolean(java.lang.String name,
                          boolean fallback)

Returns the value mapped by name if it exists and is a boolean or can be coerced to a boolean. Returns fallback otherwise.

参数:

name - the name of the property

fallback - a fallback value

返回:

the value or fallback

getDouble

public double getDouble(java.lang.String name)
                 throws JSONException

Returns the value mapped by name if it exists and is a double or can be coerced to a double.

参数:

name - the name of the property

返回:

the value

抛出:

JSONException - if the mapping doesn't exist or cannot be coerced to a double.

optDouble

public double optDouble(java.lang.String name)

Returns the value mapped by name if it exists and is a double or can be coerced to a double. Returns NaN otherwise.

参数:

name - the name of the property

返回:

the value or NaN

optDouble

public double optDouble(java.lang.String name,
                        double fallback)

Returns the value mapped by name if it exists and is a double or can be coerced to a double. Returns fallback otherwise.

参数:

name - the name of the property

fallback - a fallback value

返回:

the value or fallback

getInt

public int getInt(java.lang.String name)
           throws JSONException

Returns the value mapped by name if it exists and is an int or can be coerced to an int.

参数:

name - the name of the property

返回:

the value

抛出:

JSONException - if the mapping doesn't exist or cannot be coerced to an int.

optInt

public int optInt(java.lang.String name)

Returns the value mapped by name if it exists and is an int or can be coerced to an int. Returns 0 otherwise.

参数:

name - the name of the property

返回:

the value of 0

optInt

public int optInt(java.lang.String name,
                  int fallback)

Returns the value mapped by name if it exists and is an int or can be coerced to an int. Returns fallback otherwise.

参数:

name - the name of the property

fallback - a fallback value

返回:

the value or fallback

getLong

public long getLong(java.lang.String name)
             throws JSONException

Returns the value mapped by name if it exists and is a long or can be coerced to a long. Note that JSON represents numbers as doubles, so this is lossy; use strings to transfer numbers over JSON.

参数:

name - the name of the property

返回:

the value

抛出:

JSONException - if the mapping doesn't exist or cannot be coerced to a long.

optLong

public long optLong(java.lang.String name)

Returns the value mapped by name if it exists and is a long or can be coerced to a long. Returns 0 otherwise. Note that JSON represents numbers as doubles, so this is lossy; use strings to transfer numbers via JSON.

参数:

name - the name of the property

返回:

the value or 0L

optLong

public long optLong(java.lang.String name,
                    long fallback)

Returns the value mapped by name if it exists and is a long or can be coerced to a long. Returns fallback otherwise. Note that JSON represents numbers as doubles, so this is lossy; use strings to transfer numbers over JSON.

参数:

name - the name of the property

fallback - a fallback value

返回:

the value or fallback

getString

public java.lang.String getString(java.lang.String name)
                           throws JSONException

Returns the value mapped by name if it exists, coercing it if necessary.

参数:

name - the name of the property

返回:

the value

抛出:

JSONException - if no such mapping exists.

optString

public java.lang.String optString(java.lang.String name)

Returns the value mapped by name if it exists, coercing it if necessary. Returns the empty string if no such mapping exists.

参数:

name - the name of the property

返回:

the value or an empty string

optString

public java.lang.String optString(java.lang.String name,
                                  java.lang.String fallback)

Returns the value mapped by name if it exists, coercing it if necessary. Returns fallback if no such mapping exists.

参数:

name - the name of the property

fallback - a fallback value

返回:

the value or fallback

getJSONArray

public JSONArray getJSONArray(java.lang.String name)
                       throws JSONException

Returns the value mapped by name if it exists and is a JSONArray.

参数:

name - the name of the property

返回:

the value

抛出:

JSONException - if the mapping doesn't exist or is not a JSONArray.

optJSONArray

public JSONArray optJSONArray(java.lang.String name)

Returns the value mapped by name if it exists and is a JSONArray. Returns null otherwise.

参数:

name - the name of the property

返回:

the value or null

getJSONObject

public JSONObject getJSONObject(java.lang.String name)
                         throws JSONException

Returns the value mapped by name if it exists and is a JSONObject.

参数:

name - the name of the property

返回:

the value

抛出:

JSONException - if the mapping doesn't exist or is not a JSONObject.

optJSONObject

public JSONObject optJSONObject(java.lang.String name)

Returns the value mapped by name if it exists and is a JSONObject. Returns null otherwise.

参数:

name - the name of the property

返回:

the value or null

toJSONArray

public JSONArray toJSONArray(JSONArray names)

Returns an array with the values corresponding to names. The array contains null for names that aren't mapped. This method returns null if names is either null or empty.

参数:

names - the names of the properties

返回:

the array

keys

public java.util.Iterator keys()

Returns an iterator of the String names in this object. The returned iterator supports remove, which will remove the corresponding mapping from this object. If this object is modified after the iterator is returned, the iterator's behavior is undefined. The order of the keys is undefined.

返回:

the keys

names

public JSONArray names()

Returns an array containing the string names in this object. This method returns null if this object contains no mappings.

返回:

the array

toString

public java.lang.String toString()

Encodes this object as a compact JSON string, such as:

{"query":"Pizza","locations":[94043,90210]}

覆盖:

toString 在类中 java.lang.Object

返回:

a string representation of the object.

toString

public java.lang.String toString(int indentSpaces)
                          throws JSONException

Encodes this object as a human-readable JSON string for debugging, such as:

 {
     "query": "Pizza",
     "locations": [
         94043,
         90210
     ]
 }

参数:

indentSpaces - the number of spaces to indent for each level of nesting.

返回:

a string representation of the object.

抛出:

JSONException - if an error occurs

numberToString

public static java.lang.String numberToString(java.lang.Number number)
                                       throws JSONException

Encodes the number as a JSON string.

参数:

number - a finite value. May not be NaNs or infinities.

返回:

the encoded value

抛出:

JSONException - if an error occurs

quote

public static java.lang.String quote(java.lang.String data)

Encodes data as a JSON string. This applies quotes and any necessary character escaping.

参数:

data - the string to encode. Null will be interpreted as an empty string.

返回:

the quoted value

wrap

public static java.lang.Object wrap(java.lang.Object o)

Wraps the given object if necessary.

If the object is null or, returns NULL. If the object is a JSONArray or JSONObject, no wrapping is necessary. If the object is NULL, no wrapping is necessary. If the object is an array or Collection, returns an equivalent JSONArray. If the object is a Map, returns an equivalent JSONObject. If the object is a primitive wrapper type or String, returns the object. Otherwise if the object is from a java package, returns the result of toString. If wrapping fails, returns null.

参数:

o - the object to wrap

返回:

the wrapped object