JSONObject (hutool 2.15.0 API)

java.lang.Object
- com.xiaoleilu.hutool.getter.OptNullBasicTypeGetter<K>
- - com.xiaoleilu.hutool.getter.OptNullBasicTypeFromObjectGetter<String>
  - - com.xiaoleilu.hutool.json.JSONObject

所有已实现的接口:

BasicTypeGetter<String>, OptBasicTypeGetter<String>, JSON
```
public class JSONObject
extends OptNullBasicTypeFromObjectGetter<String>
implements JSON
```
JSONObject是一个无序键值对. 它是一个由大括号包围的，使用冒号分隔name和value的字符串，每个键值对使用逗号隔开。
此对象使用 get 和 opt 方法通过name获得value, 使用 put方法增加或替换值。
value支持的类型如下： Boolean, JSONArray, JSONObject, Number, String, 或者 JSONNull.NULL
put 方法示例：
```
 myString = new JSONObject().put("JSON", "Hello, World!").toString();
 
```
结果： {"JSON": "Hello, World"}.
toString 生成的字符串严格遵循JSON语法格式. 构造访问传入的JSON可以兼容更宽泛的语法:
- , (逗号) 可以出现在最后一个花括号之前。
- 字符串支持 ' (单引号)包围。
- 字符串可以不被引号包围，但是这个字符串不能在字符串开始位置包含引号，不能以空格开始或结尾，不能包含字符{ } [ ] / \ : , #也不能是数字或者true, false, or null这些关键字。
作者:

JSON.org，looly

构造器概要

构造器
构造器和说明
`JSONObject()` 空构造
`JSONObject(JSONObject jsonObject, String... names)` 使用其他`JSONObject`构造新的`JSONObject`，并只加入指定name对应的键值对。
`JSONObject(JSONTokener x)` Construct a JSONObject from a JSONTokener.
`JSONObject(Map<?,?> map)` Construct a JSONObject from a Map.
`JSONObject(Object bean)` Construct a JSONObject from an Object using bean getters.
`JSONObject(Object object, String[] names)` Construct a JSONObject from an Object, using reflection to find the public members.
`JSONObject(String source)` Construct a JSONObject from a source JSON text string.
`JSONObject(String baseName, Locale locale)` Construct a JSONObject from a ResourceBundle.

方法概要

方法
限定符和类型	方法和说明
`JSONObject`	`accumulate(String key, Object value)` Accumulate values under a key.
`JSONObject`	`append(String key, Object value)` Append values to the array under a key.
`Object`	`get(String key)` 获得指定KEY对应的值
`<E extends Enum<E>> E`	`getEnum(Class<E> clazz, String key)` 获得Enum类型的值
`<E extends Enum<E>> E`	`getEnum(Class<E> clazz, String key, E defaultValue)` 获得Enum类型的值
`JSONArray`	`getJSONArray(String key)` 获得JSONArray对象
`JSONObject`	`getJSONObject(String key)` 获得JSONObject对象
`Object`	`getObj(String key, Object defaultValue)` 获取Object属性值
`boolean`	`has(String key)` 是否存在指定KEY
`JSONObject`	`increment(String key)` Increment a property of a JSONObject.
`boolean`	`isNull(String key)` Determine if the value associated with the key is null or if there is no value.
`Iterator<String>`	`keys()` Get an enumeration of the keys of the JSONObject.
`Set<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.
`JSONObject`	`put(String key, boolean value)` Put a key/boolean pair in the JSONObject.
`JSONObject`	`put(String key, 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(String key, double value)` Put a key/double pair in the JSONObject.
`JSONObject`	`put(String key, int value)` Put a key/int pair in the JSONObject.
`JSONObject`	`put(String key, long value)` Put a key/long pair in the JSONObject.
`JSONObject`	`put(String key, 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(String key, Object value)` Put a key/value pair in the JSONObject.
`JSONObject`	`putOnce(String key, 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(String key, Object value)` Put a key/value pair in the JSONObject, but only if the key and the value are both non-null.
`Object`	`remove(String key)` Remove a name and its value, if present.
`boolean`	`similar(Object other)` Determine if two JSONObjects are similar.
`<T> T`	`toBean(Class<T> clazz)` 转为实体类对象
`<T> T`	`toBean(T bean)` 转为实体类对象
`JSONArray`	`toJSONArray(JSONArray names)` Produce a JSONArray containing the values of the members of this JSONObject.
`String`	`toJSONString(int indentFactor)` Make a prettyprinted JSON text of this JSONObject.
`String`	`toString()` Make a JSON text of this JSONObject.
`Writer`	`write(Writer writer)` 将JSON内容写入Writer，无缩进 Warning: This method assumes that the data structure is acyclical.
`Writer`	`write(Writer writer, int indentFactor, int indent)` 将JSON内容写入Writer Warning: This method assumes that the data structure is acyclical.

从类继承的方法 com.xiaoleilu.hutool.getter.OptNullBasicTypeFromObjectGetter
getBigDecimal, getBigInteger, getBool, getByte, getChar, getDouble, getFloat, getInt, getLong, getShort, getStr

从类继承的方法 com.xiaoleilu.hutool.getter.OptNullBasicTypeGetter
getBigDecimal, getBigInteger, getBool, getByte, getChar, getDouble, getFloat, getInt, getLong, getObj, getShort, getStr

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - JSONObject
```
public JSONObject()
```
    空构造
  - JSONObject
```
public JSONObject(JSONObject jsonObject,
          String... names)
```
    使用其他JSONObject构造新的JSONObject，并只加入指定name对应的键值对。
    
    参数:
    jsonObject - A JSONObject.
    names - 需要的name列表
  - JSONObject
```
public JSONObject(JSONTokener x)
           throws JSONException
```
    Construct a JSONObject from a JSONTokener.
    
    参数:
    x - A JSONTokener object containing the source string.
    
    抛出:
    
    JSONException - If there is a syntax error in the source string or a duplicated key.
  - JSONObject
```
public JSONObject(Map<?,?> map)
```
    Construct a JSONObject from a Map.
    
    参数:
    map - A map object that can be used to initialize the contents of the JSONObject.
  - JSONObject
```
public JSONObject(Object bean)
```
    Construct a JSONObject from an Object using bean getters. It reflects on all of the public methods of the object. For each of the methods with no parameters and a name starting with "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. 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".
    
    参数:
    bean - An object that has getter methods that should be used to make a JSONObject.
  - JSONObject
```
public JSONObject(Object object,
          String[] names)
```
    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.
    
    参数:
    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.
  - JSONObject
```
public JSONObject(String source)
           throws JSONException
```
    Construct a JSONObject from a source JSON text string. This is the most commonly used JSONObject constructor.
    
    参数:
    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.
  - JSONObject
```
public JSONObject(String baseName,
          Locale locale)
           throws JSONException
```
    Construct a JSONObject from a ResourceBundle.
    
    参数:
    baseName - The ResourceBundle base name.
    locale - The Locale to load the ResourceBundle for.
    
    抛出:
    
    JSONException - If any JSONExceptions are detected.
- 方法详细资料
  - accumulate
```
public JSONObject accumulate(String key,
                    Object value)
                      throws JSONException
```
    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. If only one value is accumulated that is not a JSONArray, then the result will be the same as using put. But if multiple values are accumulated, then the result will be like append.
    
    参数:
    key - A key string.
    value - An object to be accumulated under the key.
    
    返回:
    this.
    
    抛出:
    
    JSONException - If the value is an invalid number or if the key is null.
  - append
```
public JSONObject append(String key,
                Object value)
                  throws JSONException
```
    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.
    
    参数:
    key - A key string.
    value - An object to be accumulated under the key.
    
    返回:
    this.
    
    抛出:
    
    JSONException - If the key is null or if the current value associated with the key is not a JSONArray.
  - has
```
public boolean has(String key)
```
    是否存在指定KEY
    
    参数:
    key - A key string.
    
    返回:
    true if the key exists in the JSONObject.
  - increment
```
public JSONObject increment(String key)
                     throws JSONException
```
    Increment a property of a JSONObject. If there is no such property, create one with a value of 1. If there is such a property, and if it is an Integer, Long, Double, or Float, then add one to it.
    
    参数:
    key - A key string.
    
    返回:
    this.
    
    抛出:
    
    JSONException - If there is already a property with this name that is not an Integer, Long, Double, or Float.
  - isNull
```
public boolean isNull(String key)
```
    Determine if the value associated with the key is null or if there is no value.
    
    参数:
    key - A key string.
    
    返回:
    true if there is no value associated with the key or if the value is the JSONNull.NULL object.
  - keys
```
public Iterator<String> keys()
```
    Get an enumeration of the keys of the JSONObject.
    
    返回:
    An iterator of the keys.
  - keySet
```
public Set<String> keySet()
```
    Get a set of keys of the JSONObject.
    
    返回:
    A keySet.
  - length
```
public int length()
```
    Get the number of keys stored in the JSONObject.
    
    返回:
    The number of keys in the JSONObject.
  - names
```
public JSONArray names()
```
    Produce a JSONArray containing the names of the elements of this JSONObject.
    
    返回:
    A JSONArray containing the key strings, or null if the JSONObject is empty.
  - get
```
public Object get(String key)
```
    获得指定KEY对应的值
    
    参数:
    key - KEY
    
    返回:
    值，无对应值返回Null
  - getObj
```
public Object getObj(String key,
            Object defaultValue)
```
    从接口复制的说明: OptBasicTypeGetter
    
    获取Object属性值
    
    指定者:
    
    getObj 在接口中 OptBasicTypeGetter<String>
    
    指定者:
    
    getObj 在类中 OptNullBasicTypeFromObjectGetter<String>
    
    参数:
    key - 属性名
    defaultValue - 默认值
    
    返回:
    属性值，无对应值返回defaultValue
  - getEnum
```
public <E extends Enum<E>> E getEnum(Class<E> clazz,
                            String key)
```
    获得Enum类型的值
    
    参数:
    clazz - Enum的Class
    key - KEY
    
    返回:
    Enum类型的值，无则返回Null
  - getEnum
```
public <E extends Enum<E>> E getEnum(Class<E> clazz,
                            String key,
                            E defaultValue)
```
    获得Enum类型的值
    
    参数:
    clazz - Enum的Class
    key - KEY
    defaultValue - 默认值
    
    返回:
    Enum类型的值，无则返回Null
  - getJSONArray
```
public JSONArray getJSONArray(String key)
```
    获得JSONArray对象
    
    参数:
    key - KEY
    
    返回:
    JSONArray对象，如果值为null或者非JSONArray类型，返回null
  - getJSONObject
```
public JSONObject getJSONObject(String key)
```
    获得JSONObject对象
    
    参数:
    key - KEY
    
    返回:
    JSONArray对象，如果值为null或者非JSONObject类型，返回null
  - put
```
public JSONObject put(String key,
             boolean value)
               throws JSONException
```
    Put a key/boolean pair in the JSONObject.
    
    参数:
    key - A key string.
    value - A boolean which is the value.
    
    返回:
    this.
    
    抛出:
    
    JSONException - If the key is null.
  - put
```
public JSONObject put(String key,
             Collection<?> value)
               throws JSONException
```
    Put a key/value pair in the JSONObject, where the value will be a JSONArray which is produced from a Collection.
    
    参数:
    key - A key string.
    value - A Collection value.
    
    返回:
    this.
    
    抛出:
    
    JSONException
  - put
```
public JSONObject put(String key,
             double value)
               throws JSONException
```
    Put a key/double pair in the JSONObject.
    
    参数:
    key - A key string.
    value - A double which is the value.
    
    返回:
    this.
    
    抛出:
    
    JSONException - If the key is null or if the number is invalid.
  - put
```
public JSONObject put(String key,
             int value)
               throws JSONException
```
    Put a key/int pair in the JSONObject.
    
    参数:
    key - A key string.
    value - An int which is the value.
    
    返回:
    this.
    
    抛出:
    
    JSONException - If the key is null.
  - put
```
public JSONObject put(String key,
             long value)
               throws JSONException
```
    Put a key/long pair in the JSONObject.
    
    参数:
    key - A key string.
    value - A long which is the value.
    
    返回:
    this.
    
    抛出:
    
    JSONException - If the key is null.
  - put
```
public JSONObject put(String key,
             Map<?,?> value)
               throws JSONException
```
    Put a key/value pair in the JSONObject, where the value will be a JSONObject which is produced from a Map.
    
    参数:
    key - A key string.
    value - A Map value.
    
    返回:
    this.
    
    抛出:
    
    JSONException
  - put
```
public JSONObject put(String key,
             Object value)
               throws JSONException
```
    Put a key/value pair in the JSONObject. If the value is null, then the key will be removed from the JSONObject if it is present.
    
    参数:
    key - A key string.
    value - An object which is the value. It should be of one of these types: Boolean, Double, Integer, JSONArray, JSONObject, Long, String, or the JSONNull.NULL object.
    
    返回:
    this.
    
    抛出:
    
    JSONException - If the value is non-finite number or if the key is null.
  - putOnce
```
public JSONObject putOnce(String key,
                 Object value)
                   throws JSONException
```
    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.
    
    参数:
    key - string
    value - object
    
    返回:
    this.
    
    抛出:
    
    JSONException - if the key is a duplicate
  - putOpt
```
public JSONObject putOpt(String key,
                Object value)
                  throws JSONException
```
    Put a key/value pair in the JSONObject, but only if the key and the value are both non-null.
    
    参数:
    key - A key string.
    value - An object which is the value. It should be of one of these types: Boolean, Double, Integer, JSONArray, JSONObject, Long, String, or the JSONNull.NULL object.
    
    返回:
    this.
    
    抛出:
    
    JSONException - If the value is a non-finite number.
  - remove
```
public Object remove(String key)
```
    Remove a name and its value, if present.
    
    参数:
    key - The name to be removed.
    
    返回:
    The value that was associated with the name, or null if there was no value.
  - similar
```
public boolean similar(Object other)
```
    Determine if two JSONObjects are similar. They must contain the same set of names which must be associated with similar values.
    
    参数:
    other - The other JSONObject
    
    返回:
    true if they are equal
  - toJSONArray
```
public JSONArray toJSONArray(JSONArray names)
                      throws JSONException
```
    Produce a JSONArray containing the values of the members of this JSONObject.
    
    参数:
    names - A JSONArray containing a list of key strings. This determines the sequence of the values in the result.
    
    返回:
    A JSONArray of values.
    
    抛出:
    
    JSONException - If any of the values are non-finite numbers.
  - toBean
```
public <T> T toBean(Class<T> clazz)
```
    转为实体类对象
    
    参数:
    clazz - 实体类
    
    返回:
    实体类对象
  - toBean
```
public <T> T toBean(T bean)
```
    转为实体类对象
    
    参数:
    bean - 实体类
    
    返回:
    实体类对象
  - toString
```
public String toString()
```
    Make a JSON text of this JSONObject. For compactness, no whitespace is added. If this would not result in a syntactically correct JSON text, then null will be returned instead.
    Warning: This method assumes that the data structure is acyclical.
    
    覆盖:
    
    toString 在类中 Object
    
    返回:
    a printable, displayable, portable, transmittable representation of the object, beginning with { (left brace) and ending with } (right brace).
  - toJSONString
```
public String toJSONString(int indentFactor)
                    throws JSONException
```
    Make a prettyprinted JSON text of this JSONObject.
    Warning: This method assumes that the data structure is acyclical.
    
    指定者:
    
    toJSONString 在接口中 JSON
    
    参数:
    indentFactor - The number of spaces to add to each level of indentation.
    
    返回:
    a printable, displayable, portable, transmittable representation of the object, beginning with { (left brace) and ending with } (right brace).
    
    抛出:
    
    JSONException - If the object contains an invalid number.
  - write
```
public Writer write(Writer writer)
             throws JSONException
```
    从接口复制的说明: JSON
    
    将JSON内容写入Writer，无缩进
    Warning: This method assumes that the data structure is acyclical.
    
    指定者:
    
    write 在接口中 JSON
    
    参数:
    writer - Writer
    
    返回:
    Writer
    
    抛出:
    
    JSONException
  - write
```
public Writer write(Writer writer,
           int indentFactor,
           int indent)
             throws JSONException
```
    从接口复制的说明: JSON
    
    将JSON内容写入Writer
    Warning: This method assumes that the data structure is acyclical.
    
    指定者:
    
    write 在接口中 JSON
    
    参数:
    writer - writer
    indentFactor - 每一级别的缩进量
    indent - 顶级别缩进量
    
    返回:
    Writer
    
    抛出:
    
    JSONException

类 JSONObject

构造器概要

方法概要

从类继承的方法 com.xiaoleilu.hutool.getter.OptNullBasicTypeFromObjectGetter

从类继承的方法 com.xiaoleilu.hutool.getter.OptNullBasicTypeGetter

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

构造器详细资料

JSONObject

JSONObject

JSONObject

JSONObject

JSONObject

JSONObject

JSONObject

JSONObject

方法详细资料

accumulate

append

has

increment

isNull

keys

keySet

length

names

get

getObj

getEnum

getEnum

getJSONArray

getJSONObject

put

put

put

put

put

put

put

putOnce

putOpt

remove

similar

toJSONArray

toBean

toBean

toString

toJSONString

write

write