com.xiaoleilu.hutool.json

类 JSONObject

java.lang.Object

com.xiaoleilu.hutool.getter.OptNullBasicTypeGetter<K>

com.xiaoleilu.hutool.getter.OptNullBasicTypeFromObjectGetter<K>

com.xiaoleilu.hutool.json.JSONGetter<String>

com.xiaoleilu.hutool.json.JSONObject

所有已实现的接口:

BasicTypeGetter<String>, OptBasicTypeGetter<String>, JSON, Map<String,Object>

public class JSONObject
extends JSONGetter<String>
implements JSON, Map<String,Object>

JSON对象
例：

 myString = new JSONObject().put("JSON", "Hello, World!").toString();
 

作者:

looly

嵌套类概要

从接口继承的嵌套类/接口 java.util.Map

Map.Entry<K,V>

构造器概要

构造器

构造器和说明
JSONObject() 空构造
JSONObject(JSONObject jsonObject, String... names) 使用其他JSONObject构造新的JSONObject，并只加入指定name对应的键值对。
JSONObject(JSONTokener x) Construct a JSONObject from a JSONTokener.
JSONObject(Object source) 构建JSONObject，如果给定值为Map，将键值对加入JSON对象; 如果为普通的JavaBean，调用其getters方法（getXXX或者isXXX）获得值，加入到JSON对象 例如：如果JavaBean对象中有个方法getName()，值为"张三"，获得的键值对为：name: "张三"
JSONObject(Object object, String[] names) Construct a JSONObject from an Object, using reflection to find the public members.
JSONObject(String source) 从JSON字符串解析为JSON对象

方法概要

方法

限定符和类型	方法和说明
JSONObject	accumulate(String key, Object value) 积累值。
JSONObject	append(String key, Object value) 追加值，如果key无对应值，就添加一个JSONArray，其元素只有value，如果值已经是一个JSONArray，则添加到值JSONArray中。
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<String,Object>>	entrySet()
boolean	equals(Object other) JSON中的key以及对应的value相等则判定为与此对象相同
Object	get(Object key)
Object	getObj(String key, Object defaultValue) 获取Object属性值
JSONObject	increment(String key) 对值加一，如果值不存在，赋值1，如果为数字类型，做加一操作
boolean	isEmpty()
boolean	isNull(String key) Determine if the value associated with the key is null or if there is no value.
Set<String>	keySet()
JSONObject	put(String key, Object value) PUT 键值对到JSONObject中，如果值为null，将此键移除
void	putAll(Map<? extends String,? extends Object> m)
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到JSONObject中
Object	remove(Object key)
int	size()
<T> T	toBean(Class<T> clazz) 转为实体类对象
<T> T	toBean(T bean) 转为实体类对象
JSONArray	toJSONArray(Collection<String> names) 将指定KEY列表的值组成新的JSONArray
String	toJSONString(int indentFactor) Make a prettyprinted JSON text of this JSONObject.
String	toString() Make a JSON text of this JSONObject.
Collection<Object>	values()
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.json.JSONGetter

getJSONArray, getJSONObject

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

getBigDecimal, getBigInteger, getBool, getByte, getChar, getDouble, getEnum, getFloat, getInt, getLong, getShort, getStr

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

getBigDecimal, getBigInteger, getBool, getByte, getChar, getDouble, getEnum, getFloat, getInt, getLong, getObj, getShort, getStr

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

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

从接口继承的方法 java.util.Map

hashCode

构造器详细资料

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(Object source)

构建JSONObject，如果给定值为Map，将键值对加入JSON对象;
如果为普通的JavaBean，调用其getters方法（getXXX或者isXXX）获得值，加入到JSON对象
例如：如果JavaBean对象中有个方法getName()，值为"张三"，获得的键值对为：name: "张三"

参数:

source - JavaBean或者Map对象或者String

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

从JSON字符串解析为JSON对象

参数:

source - 以大括号 {} 包围的字符串，其中KEY和VALUE使用 : 分隔，每个键值对使用逗号分隔

抛出:

JSONException - JSON字符串语法错误

方法详细资料

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.

toJSONArray

public JSONArray toJSONArray(Collection<String> names)
                      throws JSONException

将指定KEY列表的值组成新的JSONArray

参数:

names - KEY列表

返回:

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 - 实体类

返回:

实体类对象

size

public int size()

指定者:

size 在接口中 Map<String,Object>

isEmpty

public boolean isEmpty()

指定者:

isEmpty 在接口中 Map<String,Object>

containsKey

public boolean containsKey(Object key)

指定者:

containsKey 在接口中 Map<String,Object>

containsValue

public boolean containsValue(Object value)

指定者:

containsValue 在接口中 Map<String,Object>

get

public Object get(Object key)

指定者:

get 在接口中 Map<String,Object>

getObj

public Object getObj(String key,
            Object defaultValue)

从接口复制的说明: OptBasicTypeGetter

获取Object属性值

指定者:

getObj 在接口中 OptBasicTypeGetter<String>

指定者:

getObj 在类中 OptNullBasicTypeFromObjectGetter<String>

参数:

key - 属性名

defaultValue - 默认值

返回:

属性值，无对应值返回defaultValue

put

public JSONObject put(String key,
             Object value)
               throws JSONException

PUT 键值对到JSONObject中，如果值为null，将此键移除

指定者:

put 在接口中 Map<String,Object>

参数:

key - A key string.

value - 值对象. 可以是以下类型: Boolean, Double, Integer, JSONArray, JSONObject, Long, String, or the JSONNull.NULL.

返回:

this.

抛出:

JSONException - 值是无穷数字抛出此异常

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. 一次性Put 键值对，如果key已经存在抛出异常，如果键值中有null值，忽略

参数:

key - 键

value - 值对象，可以是以下类型: Boolean, Double, Integer, JSONArray, JSONObject, Long, String, or the JSONNull.NULL.

返回:

this.

抛出:

JSONException - 值是无穷数字、键重复抛出异常

putOpt

public JSONObject putOpt(String key,
                Object value)
                  throws JSONException

在键和值都为非空的情况下put到JSONObject中

参数:

key - 键

value - 值对象，可以是以下类型: Boolean, Double, Integer, JSONArray, JSONObject, Long, String, or the JSONNull.NULL.

返回:

this.

抛出:

JSONException - 值是无穷数字

putAll

public void putAll(Map<? extends String,? extends Object> m)

指定者:

putAll 在接口中 Map<String,Object>

accumulate

public JSONObject accumulate(String key,
                    Object value)
                      throws JSONException

积累值。类似于put，当key对应value已经存在时，与value组成新的JSONArray.
如果只有一个值，此值就是value，如果多个值，则是添加到新的JSONArray中

参数:

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

追加值，如果key无对应值，就添加一个JSONArray，其元素只有value，如果值已经是一个JSONArray，则添加到值JSONArray中。

参数:

key - A key string.

value - An object to be accumulated under the key.

返回:

this.

抛出:

JSONException - 如果给定键为null或者键对应的值存在且为非JSONArray

increment

public JSONObject increment(String key)
                     throws JSONException

对值加一，如果值不存在，赋值1，如果为数字类型，做加一操作

参数:

key - A key string.

返回:

this.

抛出:

JSONException - If there is already a property with this name that is not an Integer, Long, Double, or Float.

remove

public Object remove(Object key)

指定者:

remove 在接口中 Map<String,Object>

clear

public void clear()

指定者:

clear 在接口中 Map<String,Object>

keySet

public Set<String> keySet()

指定者:

keySet 在接口中 Map<String,Object>

values

public Collection<Object> values()

指定者:

values 在接口中 Map<String,Object>

entrySet

public Set<Map.Entry<String,Object>> entrySet()

指定者:

entrySet 在接口中 Map<String,Object>

equals

public boolean equals(Object other)

JSON中的key以及对应的value相等则判定为与此对象相同

指定者:

equals 在接口中 Map<String,Object>

覆盖:

equals 在类中 Object

参数:

other - The other JSONObject

返回:

true if they are equal

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