JSONObject (hutool 6.0.0-M20 API)

java.lang.Object
- org.dromara.hutool.core.map.MapWrapper<String,JSON>
- - org.dromara.hutool.json.JSONObject

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Map.Entry<String,JSON>>, Map<String,JSON>, TypeGetter<String>, Wrapper<Map<String,JSON>>, JSON, JSONGetter<String>
```
public class JSONObject
extends MapWrapper<String,JSON>
implements JSON, JSONGetter<String>
```
JSON对象
对象是 JSON 中的映射类型。他们将“键”映射到“值”。在 JSON 中，“键”必须始终是字符串。这些对中的每一组通常被称为“属性”。
例：
```
   json = new JSONObject().put("JSON", "Hello, World!").toString();
 
```
Author:

looly

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_CAPACITY
默认初始大小
- Fields inherited from class org.dromara.hutool.core.map.MapWrapper
  DEFAULT_INITIAL_CAPACITY, DEFAULT_LOAD_FACTOR

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_CAPACITY` 默认初始大小

Constructor Summary

Constructors
Constructor and Description
`JSONObject()` 构造，初始容量为 `DEFAULT_CAPACITY`，KEY有序
`JSONObject(int capacity)` 构造
`JSONObject(int capacity, JSONConfig config)` 构造
`JSONObject(int capacity, JSONFactory factory)` 构造
`JSONObject(JSONConfig config)` 构造

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JSONObject`	`append(String key, Object value)` 追加值.
`<P,T> T`	`get(SerFunction<P,T> func)` 根据lambda的方法引用，获取
`JSONFactory`	`getFactory()` 获取JSON工厂
`JSON`	`getJSON(String key)` 获取JSON对象在JSON树模型中，JSON的节点都以JSON格式存储，所有get方法都基于此方法
`Object`	`getObj(String key, Object defaultValue)` 获取Object属性值
`JSONObject`	`increment(String key)` 对值加一，如果值不存在，赋值1，如果为数字类型，做加一操作
`JSON`	`put(String key, JSON value)` 设置键值对到JSONObject中，在忽略null模式下，如果值为`null`，将此键移除
`JSONObject`	`putAllValue(Map<?,?> map)` 设置所有键值对到JSONObject中，在忽略null模式下，如果值为`null`，将此键移除
`JSONObject`	`putFields(SerSupplier<?>... fields)` 通过lambda批量设置值实际使用时，可以使用getXXX的方法引用来完成键值对的赋值： `User user = GenericBuilder.of(User::new).with(User::setUsername, "hutool").build(); (new JSONObject()).setFields(user::getNickname, user::getUsername);`
`JSONObject`	`putNull(String key)` 设置设置`null`值。
`JSONObject`	`putValue(String key, Boolean value)` 设置键值对到JSONObject中，在忽略null模式下，如果值为`null`，将此键移除
`JSONObject`	`putValue(String key, Character value)` 设置键值对到JSONObject中，在忽略null模式下，如果值为`null`，将此键移除
`JSONObject`	`putValue(String key, Number value)` 设置键值对到JSONObject中，在忽略null模式下，如果值为`null`，将此键移除
`JSONObject`	`putValue(String key, Object value)` 设置键值对到JSONObject中，在忽略null模式下，如果值为`null`，将此键移除
`JSONObject`	`putValue(String key, String value)` 设置键值对到JSONObject中，在忽略null模式下，如果值为`null`，将此键移除
`<K,V> Map<K,V>`	`toMap(Class<K> keyType, Class<V> valueType)` 将JSONObject转换为指定类型的Map
`String`	`toString()`
`void`	`write(JSONWriter writer)` 将JSON内容写入Writer Warning: This method assumes that the data structure is acyclical.

Methods inherited from class org.dromara.hutool.core.map.MapWrapper
clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, getRaw, hashCode, isEmpty, iterator, keySet, merge, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dromara.hutool.json.JSON
asJSONArray, asJSONObject, asJSONPrimitive, config, getByPath, getByPath, getObjByPath, isEmpty, putByPath, size, toBean, toJSONString, toJSONString, toStringPretty

Methods inherited from interface org.dromara.hutool.json.JSONGetter
get, getBeanList, getJSONArray, getJSONObject, getStrEscaped, getStrEscaped, isNull

Methods inherited from interface org.dromara.hutool.core.lang.getter.TypeGetter
get, get, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBool, getBool, getByte, getByte, getBytes, getBytes, getChar, getChar, getDate, getDate, getDouble, getDouble, getEnum, getEnum, getFloat, getFloat, getInt, getInt, getLocalDate, getLocalDate, getLocalDateTime, getLocalDateTime, getLocalTime, getLocalTime, getLong, getLong, getNumber, getNumber, getObj, getShort, getShort, getSqlTime, getSqlTime, getSqlTimestamp, getSqlTimestamp, getStr, getStr

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - DEFAULT_CAPACITY
```
public static final int DEFAULT_CAPACITY
```
    默认初始大小
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JSONObject
```
public JSONObject()
```
    构造，初始容量为 DEFAULT_CAPACITY，KEY有序
  - JSONObject
```
public JSONObject(int capacity)
```
    构造
    
    Parameters:
    
    capacity - 初始大小
  - JSONObject
```
public JSONObject(JSONConfig config)
```
    构造
    
    Parameters:
    
    config - JSON配置项
    
    Since:
    
    4.6.5
  - JSONObject
```
public JSONObject(int capacity,
                  JSONConfig config)
```
    构造
    
    Parameters:
    
    capacity - 初始大小
    
    config - JSON配置项，null则使用默认配置
  - JSONObject
```
public JSONObject(int capacity,
                  JSONFactory factory)
```
    构造
    
    Parameters:
    
    capacity - 初始大小
    
    factory - JSON工厂类
- Method Detail
  - getFactory
```
public JSONFactory getFactory()
```
    Description copied from interface: JSON
    
    获取JSON工厂
    
    Specified by:
    
    getFactory in interface JSON
    
    Specified by:
    
    getFactory in interface JSONGetter<String>
    
    Returns:
    
    JSON工厂
  - write
```
public void write(JSONWriter writer)
           throws JSONException
```
    Description copied from interface: JSON
    
    将JSON内容写入Writer
    Warning: This method assumes that the data structure is acyclical.
    
    Specified by:
    
    write in interface JSON
    
    Parameters:
    
    writer - writer
    
    Throws:
    
    JSONException - JSON相关异常
  - get
```
public <P,T> T get(SerFunction<P,T> func)
```
    根据lambda的方法引用，获取
    
    Type Parameters:
    
    P - 参数类型
    
    T - 返回值类型
    
    Parameters:
    
    func - 方法引用
    
    Returns:
    
    获取表达式对应属性和返回的对象
  - getObj
```
public Object getObj(String key,
                     Object defaultValue)
```
    Description copied from interface: TypeGetter
    
    获取Object属性值
    
    Specified by:
    
    getObj in interface TypeGetter<String>
    
    Specified by:
    
    getObj in interface JSONGetter<String>
    
    Parameters:
    
    key - 属性名
    
    defaultValue - 默认值
    
    Returns:
    
    属性值，无对应值返回defaultValue
  - getJSON
```
public JSON getJSON(String key)
```
    Description copied from interface: JSONGetter
    
    获取JSON对象
    在JSON树模型中，JSON的节点都以JSON格式存储，所有get方法都基于此方法
    
    Specified by:
    
    getJSON in interface JSONGetter<String>
    
    Parameters:
    
    key - KEY
    
    Returns:
    
    JSON对象
  - increment
```
public JSONObject increment(String key)
                     throws JSONException
```
    对值加一，如果值不存在，赋值1，如果为数字类型，做加一操作
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - 如果存在值非Integer, Long, Double, 或 Float.
  - append
```
public JSONObject append(String key,
                         Object value)
                  throws JSONException
```
    追加值.
    - 如果键值对不存在或对应值为null，则value为单独值
    - 如果值是一个JSONArray，追加之
    - 如果值是一个其他值，则和旧值共同组合为一个JSONArray
    Parameters:
    
    key - 键
    
    value - 值
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - 如果给定键为null或者键对应的值存在且为非JSONArray
    
    Since:
    
    6.0.0
  - putFields
```
public JSONObject putFields(SerSupplier<?>... fields)
```
    通过lambda批量设置值
    实际使用时，可以使用getXXX的方法引用来完成键值对的赋值：
```
     User user = GenericBuilder.of(User::new).with(User::setUsername, "hutool").build();
     (new JSONObject()).setFields(user::getNickname, user::getUsername);
 
```
    Parameters:
    
    fields - lambda,不能为空
    
    Returns:
    
    this
  - putAllValue
```
public JSONObject putAllValue(Map<?,?> map)
```
    设置所有键值对到JSONObject中，在忽略null模式下，如果值为null，将此键移除
    
    Parameters:
    
    map - 键值对
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - 值是无穷数字抛出此异常
  - putNull
```
public JSONObject putNull(String key)
```
    设置设置null值。在忽略null模式下移除对应键值对。
    
    Parameters:
    
    key - 键
    
    Returns:
    
    this.
  - putValue
```
public JSONObject putValue(String key,
                           Boolean value)
                    throws JSONException
```
    设置键值对到JSONObject中，在忽略null模式下，如果值为null，将此键移除
    
    Parameters:
    
    key - 键
    
    value - Boolean类型对象
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - 值是无穷数字抛出此异常
  - putValue
```
public JSONObject putValue(String key,
                           Number value)
                    throws JSONException
```
    设置键值对到JSONObject中，在忽略null模式下，如果值为null，将此键移除
    
    Parameters:
    
    key - 键
    
    value - Number类型对象
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - 值是无穷数字抛出此异常
  - putValue
```
public JSONObject putValue(String key,
                           Character value)
                    throws JSONException
```
    设置键值对到JSONObject中，在忽略null模式下，如果值为null，将此键移除
    
    Parameters:
    
    key - 键
    
    value - Character类型对象
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - 值是无穷数字抛出此异常
  - putValue
```
public JSONObject putValue(String key,
                           String value)
                    throws JSONException
```
    设置键值对到JSONObject中，在忽略null模式下，如果值为null，将此键移除
    
    Parameters:
    
    key - 键
    
    value - String类型对象
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - 值是无穷数字抛出此异常
  - putValue
```
public JSONObject putValue(String key,
                           Object value)
                    throws JSONException
```
    设置键值对到JSONObject中，在忽略null模式下，如果值为null，将此键移除
    
    Parameters:
    
    key - 键
    
    value - 值对象. 可以是以下类型: Boolean, Double, Integer, JSONArray, JSONObject, Long, String, or the null
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - 值是无穷数字抛出此异常
  - put
```
public JSON put(String key,
                JSON value)
         throws JSONException
```
    设置键值对到JSONObject中，在忽略null模式下，如果值为null，将此键移除
    
    Specified by:
    
    put in interface Map<String,JSON>
    
    Overrides:
    
    put in class MapWrapper<String,JSON>
    
    Parameters:
    
    key - 键
    
    value - 值对象. 可以是以下类型: Boolean, Double, Integer, JSONArray, JSONObject, Long, String, or the JSONNull.NULL.
    
    Returns:
    
    旧值
    
    Throws:
    
    JSONException - 值是无穷数字抛出此异常
  - toMap
```
public <K,V> Map<K,V> toMap(Class<K> keyType,
                            Class<V> valueType)
```
    将JSONObject转换为指定类型的Map
    
    Type Parameters:
    
    K - 键类型
    
    V - 值类型
    
    Parameters:
    
    keyType - 键类型Class
    
    valueType - 值类型Class
    
    Returns:
    
    Map
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class MapWrapper<String,JSON>

Class JSONObject

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class org.dromara.hutool.core.map.MapWrapper

Constructor Summary

Method Summary

Methods inherited from class org.dromara.hutool.core.map.MapWrapper

Methods inherited from class java.lang.Object

Methods inherited from interface org.dromara.hutool.json.JSON

Methods inherited from interface org.dromara.hutool.json.JSONGetter

Methods inherited from interface org.dromara.hutool.core.lang.getter.TypeGetter

Methods inherited from interface java.lang.Iterable

Field Detail

DEFAULT_CAPACITY

Constructor Detail

JSONObject

JSONObject

JSONObject

JSONObject

JSONObject

Method Detail

getFactory

write

get

getObj

getJSON

increment

append

putFields

putAllValue

putNull

putValue

putValue

putValue

putValue

putValue

put

toMap

toString