ZSONObject

java.lang.Object
- ohos.utils.zson.ZSONObject

```
public class ZSONObject
extends Object
```
Provides methods for processing objects of JSON structured data.
Based on the standard JSON data structure, this class encapsulates a series of read and write methods for different data types, for example, primitive data types like int and float as well as some custom data types. It also provides methods for conversion between strings and objects. With these methods, you can process JSON structured data easily.

从以下版本开始:

1

构造器概要

构造器
构造器	说明
`ZSONObject()`	Default constructor used to create a `ZSONObject` instance.
`ZSONObject(Map<String,Object> map)`	A constructor used to create a `ZSONObject` object based on a specified `map`.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法	说明
`static ZSONObject`	`classToZSON(Object object)`	Converts a specified class object into a `ZSONObject`.
`void`	`clear()`	Clears the map of the entire `ZSONObject`.
`boolean`	`containsKey(Object key)`	Checks whether the map of this `ZSONObject` contains an object matching the specified key.
`boolean`	`containsValue(Object value)`	Checks whether the map of this `ZSONObject` contains a value object.
`Set<Map.Entry<String,Object>>`	`entrySet()`	Obtains the `entrySet` in the map of this `ZSONObject`.
`Object`	`get(Object key)`	Obtains the object matching the specified key in the map of this `ZSONObject`.
`BigDecimal`	`getBigDecimal(String key)`	Obtains the `BigDecimal` object matching the specified key in the map of this `ZSONObject`.
`BigInteger`	`getBigInteger(String key)`	Obtains the `BigInteger` object matching the specified key in the map of this `ZSONObject`.
`Boolean`	`getBoolean(String key)`	Obtains the `boolean` value matching the specified key in the map of this `ZSONObject` and automatically converts the value into a `Boolean` object.
`boolean`	`getBooleanValue(String key)`	Obtains the `boolean` value matching the specified key in the map of this `ZSONObject`.
`Byte`	`getByte(String key)`	Obtains the `byte` value matching the specified key in the map of this `ZSONObject` and automatically converts the value into a `Byte` object.
`byte[]`	`getBytes(String key)`	Obtains the `byte` array matching the specified key in the map of this `ZSONObject`.
`byte`	`getByteValue(String key)`	Obtains the `byte` value matching the specified key in the map of this `ZSONObject`.
`Date`	`getDate(String key)`	Obtains the `Date` object matching the specified key in the map of this `ZSONObject`.
`Double`	`getDouble(String key)`	Obtains the `double` value matching the specified key in the map of this `ZSONObject` and automatically converts the value into a `Double` object.
`double`	`getDoubleValue(String key)`	Obtains the `double` value matching the specified key in the map of this `ZSONObject`.
`Float`	`getFloat(String key)`	Obtains the `float` value matching the specified key in the map of this `ZSONObject` and automatically converts the value into a `Float` object.
`float`	`getFloatValue(String key)`	Obtains the `float` value matching the specified key in the map of this `ZSONObject`.
`Integer`	`getInteger(String key)`	Obtains the `int` value matching the specified key in the map of this `ZSONObject` and automatically converts the value into an `Integer` object.
`int`	`getIntValue(String key)`	Obtains the `int` value matching the specified key in the map of this `ZSONObject`.
`Long`	`getLong(String key)`	Obtains the `long` value matching the specified key in the map of this `ZSONObject` and automatically converts the value into a `Long` object.
`long`	`getLongValue(String key)`	Obtains the `long` value matching the specified key in the map of this `ZSONObject`.
`<T> T`	`getObject(String key, Class<T> clazz)`	Obtains the object matching the specified key in the map of this `ZSONObject` and converts it into a class object specified by `clazz`.
`Short`	`getShort(String key)`	Obtains the `short` value matching the specified key in the map of this `ZSONObject` and automatically converts the value into a `Short` object.
`short`	`getShortValue(String key)`	Obtains the `short` value matching the specified key in the map of this `ZSONObject`.
`String`	`getString(String key)`	Obtains the `String` object matching the specified key in the map of this `ZSONObject`.
`ZSONArray`	`getZSONArray(String key)`	Obtains the array matching the specified key in the map of this `ZSONObject`.
`ZSONObject`	`getZSONObject(String key)`	Obtains the nested child `ZSONObject` matching the specified key in the map of the parent `ZSONObject`.
`boolean`	`isEmpty()`	Checks whether this `ZSONObject` contains no object.
`Set<String>`	`keySet()`	Obtains the map that stores keys in this `ZSONObject`.
`Object`	`put(String key, Object value)`	Puts a specified key-value pair to the map of this `ZSONObject`.
`void`	`putAll(Map<? extends String,?> m)`	Puts a map of key-value pairs into the map of this `ZSONObject`.
`Object`	`remove(Object key)`
`int`	`size()`	Obtains the size of this `ZSONObject`.
`static <T> T`	`stringToClass(String text, Class<T> clazz)`	Converts a given JSON string to an object of the `Class` type.
`static ZSONObject`	`stringToZSON(String text)`	Converts a given JSON string to an object of the `ZSONObject` type.
`String`	`toString()`	Converts this `ZSONObject` object into a JSON string.
`ZSONArray`	`toZSONArray(String[] names)`	Obtains a list of values matching the keys contained in the `names` array from this `ZSONObject` instance.
`static String`	`toZSONString(Object object)`	Converts a given object to a JSON string.
`Collection<Object>`	`values()`	Obtains the `Collection` that stores values in this `ZSONObject`.

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

- 构造器详细资料
  - ZSONObject
```
public ZSONObject()
```
    Default constructor used to create a ZSONObject instance.
    
    从以下版本开始:
    
    1
  - ZSONObject
```
public ZSONObject(Map<String,Object> map)
```
    A constructor used to create a ZSONObject object based on a specified map.
    
    参数:
    
    map - Indicates the map used to create the ZSONObject object.
    
    从以下版本开始:
    
    1
- 方法详细资料
  - stringToClass
```
public static final <T> T stringToClass(String text,
                                        Class<T> clazz)
```
    Converts a given JSON string to an object of the Class type.
    
    参数:
    
    text - Indicates the JSON-compliant string to be converted.
    
    clazz - Indicates the Class type of the object to return.
    
    返回:
    
    Returns the object of the Class type.
    
    抛出:
    
    ZSONException - Throws this exception when any error occurs.
    
    从以下版本开始:
    
    1
  - stringToZSON
```
public static final ZSONObject stringToZSON(String text)
```
    Converts a given JSON string to an object of the ZSONObject type.
    
    参数:
    
    text - Indicates the JSON string to be converted.
    
    返回:
    
    Returns the object of the ZSONObject type if the string is successfully converted; Otherwise, return null.
    
    抛出:
    
    ZSONException - Throws this exception when any error occurs.
    
    从以下版本开始:
    
    1
  - toZSONString
```
public static final String toZSONString(Object object)
```
    Converts a given object to a JSON string.
    
    参数:
    
    object - Indicates the object to be converted.
    
    返回:
    
    Returns the JSON string.
    
    抛出:
    
    ZSONException - Throws this exception when any error occurs.
    
    从以下版本开始:
    
    1
  - classToZSON
```
public static final ZSONObject classToZSON(Object object)
```
    Converts a specified class object into a ZSONObject.
    
    参数:
    
    object - Indicates the class object to convert.
    
    返回:
    
    Returns the converted ZSONObject.
    
    抛出:
    
    ZSONException - Throws this exception when any error occurs.
    
    从以下版本开始:
    
    3
  - size
```
public int size()
```
    Obtains the size of this ZSONObject.
    
    返回:
    
    Returns the size of this ZSONObject.
    
    从以下版本开始:
    
    3
  - isEmpty
```
public boolean isEmpty()
```
    Checks whether this ZSONObject contains no object.
    
    返回:
    
    Returns true if this ZSONObject contains no object; returns false otherwise.
    
    从以下版本开始:
    
    3
  - containsKey
```
public boolean containsKey(Object key)
```
    Checks whether the map of this ZSONObject contains an object matching the specified key.
    
    参数:
    
    key - Indicates the key stored in the map of this ZSONObject.
    
    返回:
    
    Returns true if the map of this ZSONObject contains an object matching the specified key; returns false otherwise.
    
    从以下版本开始:
    
    3
  - containsValue
```
public boolean containsValue(Object value)
```
    Checks whether the map of this ZSONObject contains a value object.
    
    参数:
    
    value - Indicates the value stored in the map of this ZSONObject.
    
    返回:
    
    Returns true if the map of this ZSONObject contains a value object; returns false otherwise.
    
    从以下版本开始:
    
    3
  - get
```
public Object get(Object key)
```
    Obtains the object matching the specified key in the map of this ZSONObject.
    
    参数:
    
    key - Indicates the key stored in the map of this ZSONObject.
    
    返回:
    
    Returns the matching object.
    
    从以下版本开始:
    
    3
  - getZSONObject
```
public ZSONObject getZSONObject(String key)
```
    Obtains the nested child ZSONObject matching the specified key in the map of the parent ZSONObject.
    
    参数:
    
    key - Indicates the key stored in the map of the parent ZSONObject.
    
    返回:
    
    Returns the matching child ZSONObject, or null if the object is not found.
    
    从以下版本开始:
    
    3
  - getZSONArray
```
public ZSONArray getZSONArray(String key)
```
    Obtains the array matching the specified key in the map of this ZSONObject.
    
    参数:
    
    key - Indicates the key stored in the map of the parent ZSONObject.
    
    返回:
    
    Returns the matching array, or null if the array is not found.
    
    从以下版本开始:
    
    3
  - getObject
```
public <T> T getObject(String key,
                       Class<T> clazz)
```
    Obtains the object matching the specified key in the map of this ZSONObject and converts it into a class object specified by clazz.
    
    参数:
    
    key - Indicates the key stored in the map of this ZSONObject.
    
    clazz - Indicates the class type of the object to return. This object is converted from the value stored in the map of this ZSONObject.
    
    返回:
    
    Returns the class object converted from the matching object.
    
    从以下版本开始:
    
    3
  - getBoolean
```
public Boolean getBoolean(String key)
```
    Obtains the boolean value matching the specified key in the map of this ZSONObject and automatically converts the value into a Boolean object.
    
    参数:
    
    key - Indicates the key stored in the map of this ZSONObject.
    
    返回:
    
    Returns the matching Boolean object.
    
    从以下版本开始:
    
    3
  - getBooleanValue
```
public boolean getBooleanValue(String key)
```
    Obtains the boolean value matching the specified key in the map of this ZSONObject.
    
    参数:
    
    key - Indicates the key stored in the map of this ZSONObject.
    
    返回:
    
    Returns the matching boolean value.
    
    从以下版本开始:
    
    3
  - getBytes
```
public byte[] getBytes(String key)
```
    Obtains the byte array matching the specified key in the map of this ZSONObject.
    
    参数:
    
    key - Indicates the key stored in the map of this ZSONObject.
    
    返回:
    
    Returns the matching byte array.
    
    从以下版本开始:
    
    3
  - getByte
```
public Byte getByte(String key)
```
    Obtains the byte value matching the specified key in the map of this ZSONObject and automatically converts the value into a Byte object.
    
    参数:
    
    key - Indicates the key stored in the map of this ZSONObject.
    
    返回:
    
    Returns the matching Byte object.
    
    从以下版本开始:
    
    3
  - getByteValue
```
public byte getByteValue(String key)
```
    Obtains the byte value matching the specified key in the map of this ZSONObject.
    
    参数:
    
    key - Indicates the key stored in the map of this ZSONObject.
    
    返回:
    
    Returns the matching byte value.
    
    从以下版本开始:
    
    3
  - getShort
```
public Short getShort(String key)
```
    Obtains the short value matching the specified key in the map of this ZSONObject and automatically converts the value into a Short object.
    
    参数:
    
    key - Indicates the key stored in the map of this ZSONObject.
    
    返回:
    
    Returns the matching Short object.
    
    从以下版本开始:
    
    3
  - getShortValue
```
public short getShortValue(String key)
```
    Obtains the short value matching the specified key in the map of this ZSONObject.
    
    参数:
    
    key - Indicates the key stored in the map of this ZSONObject.
    
    返回:
    
    Returns the matching short value.
    
    从以下版本开始:
    
    3
  - getInteger
```
public Integer getInteger(String key)
```
    Obtains the int value matching the specified key in the map of this ZSONObject and automatically converts the value into an Integer object.
    
    参数:
    
    key - Indicates the key stored in the map of this ZSONObject.
    
    返回:
    
    Returns the matching Integer object.
    
    从以下版本开始:
    
    3
  - getIntValue
```
public int getIntValue(String key)
```
    Obtains the int value matching the specified key in the map of this ZSONObject.
    
    参数:
    
    key - Indicates the key stored in the map of this ZSONObject.
    
    返回:
    
    Returns the matching int value.
    
    从以下版本开始:
    
    3
  - getLong
```
public Long getLong(String key)
```
    Obtains the long value matching the specified key in the map of this ZSONObject and automatically converts the value into a Long object.
    
    参数:
    
    key - Indicates the key stored in the map of this ZSONObject.
    
    返回:
    
    Returns the matching Long object.
    
    从以下版本开始:
    
    3
  - getLongValue
```
public long getLongValue(String key)
```
    Obtains the long value matching the specified key in the map of this ZSONObject.
    
    参数:
    
    key - Indicates the key stored in the map of this ZSONObject.
    
    返回:
    
    Returns the matching long value.
    
    从以下版本开始:
    
    3
  - getFloat
```
public Float getFloat(String key)
```
    Obtains the float value matching the specified key in the map of this ZSONObject and automatically converts the value into a Float object.
    
    参数:
    
    key - Indicates the key stored in the map of this ZSONObject.
    
    返回:
    
    Returns the matching Float object.
    
    从以下版本开始:
    
    3
  - getFloatValue
```
public float getFloatValue(String key)
```
    Obtains the float value matching the specified key in the map of this ZSONObject.
    
    参数:
    
    key - Indicates the key stored in the map of this ZSONObject.
    
    返回:
    
    Returns the matching float value.
    
    从以下版本开始:
    
    3
  - getDouble
```
public Double getDouble(String key)
```
    Obtains the double value matching the specified key in the map of this ZSONObject and automatically converts the value into a Double object.
    
    参数:
    
    key - Indicates the key stored in the map of this ZSONObject.
    
    返回:
    
    Returns the matching Double object.
    
    从以下版本开始:
    
    3
  - getDoubleValue
```
public double getDoubleValue(String key)
```
    Obtains the double value matching the specified key in the map of this ZSONObject.
    
    参数:
    
    key - Indicates the key stored in the map of this ZSONObject.
    
    返回:
    
    Returns the matching double value.
    
    从以下版本开始:
    
    3
  - getBigDecimal
```
public BigDecimal getBigDecimal(String key)
```
    Obtains the BigDecimal object matching the specified key in the map of this ZSONObject.
    
    参数:
    
    key - Indicates the key stored in the map of this ZSONObject.
    
    返回:
    
    Returns the matching BigDecimal object.
    
    从以下版本开始:
    
    3
  - getBigInteger
```
public BigInteger getBigInteger(String key)
```
    Obtains the BigInteger object matching the specified key in the map of this ZSONObject.
    
    参数:
    
    key - Indicates the key stored in the map of this ZSONObject.
    
    返回:
    
    Returns the matching BigInteger object.
    
    从以下版本开始:
    
    3
  - getString
```
public String getString(String key)
```
    Obtains the String object matching the specified key in the map of this ZSONObject.
    
    参数:
    
    key - Indicates the key stored in the map of this ZSONObject.
    
    返回:
    
    Returns the matching String object.
    
    从以下版本开始:
    
    3
  - getDate
```
public Date getDate(String key)
```
    Obtains the Date object matching the specified key in the map of this ZSONObject.
    
    参数:
    
    key - Indicates the key stored in the map of this ZSONObject.
    
    返回:
    
    Returns the matching Date object.
    
    从以下版本开始:
    
    3
  - put
```
public Object put(String key,
                  Object value)
```
    Puts a specified key-value pair to the map of this ZSONObject.
    
    参数:
    
    key - Indicates the key to be stored in the map of this ZSONObject.
    
    value - Indicates the value to be stored in the map of this ZSONObject.
    
    返回:
    
    The previous value associated with key.
    
    从以下版本开始:
    
    3
  - putAll
```
public void putAll(Map<? extends String,?> m)
```
    Puts a map of key-value pairs into the map of this ZSONObject.
    
    参数:
    
    m - Indicates the map to put. Its keys are String objects or the objects from which it extends.
    
    从以下版本开始:
    
    3
  - clear
```
public void clear()
```
    Clears the map of the entire ZSONObject.
    
    从以下版本开始:
    
    3
  - remove
```
public Object remove(Object key)
```
  - keySet
```
public Set<String> keySet()
```
    Obtains the map that stores keys in this ZSONObject.
    
    返回:
    
    Returns the map that stores keys in this ZSONObject.
    
    从以下版本开始:
    
    3
  - values
```
public Collection<Object> values()
```
    Obtains the Collection that stores values in this ZSONObject.
    
    返回:
    
    Returns the Collection that stores values in this ZSONObject.
    
    从以下版本开始:
    
    3
  - entrySet
```
public Set<Map.Entry<String,Object>> entrySet()
```
    Obtains the entrySet in the map of this ZSONObject.
    
    返回:
    
    Returns the entrySet in the map of this ZSONObject.
    
    从以下版本开始:
    
    3
  - toZSONArray
```
public ZSONArray toZSONArray(String[] names)
```
    Obtains a list of values matching the keys contained in the names array from this ZSONObject instance.
    The list is a ZSONArray instance whose elements are ordered in the same sequence as names.
    
    参数:
    
    names - Indicates the keys whose values are to be obtained.
    
    返回:
    
    Returns a ZSONArray instance.
    
    抛出:
    
    NullPointerException - Throws this exception if names is null.
    
    从以下版本开始:
    
    4
  - toString
```
public String toString()
```
    Converts this ZSONObject object into a JSON string.
    
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    Returns the JSON string.
    
    从以下版本开始:
    
    5

类 ZSONObject

构造器概要

方法概要

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

构造器详细资料

ZSONObject

ZSONObject

方法详细资料

stringToClass

stringToZSON

toZSONString

classToZSON

size

isEmpty

containsKey

containsValue

get

getZSONObject

getZSONArray

getObject

getBoolean

getBooleanValue

getBytes

getByte

getByteValue

getShort

getShortValue

getInteger

getIntValue

getLong

getLongValue

getFloat

getFloatValue

getDouble

getDoubleValue

getBigDecimal

getBigInteger

getString

getDate

put

putAll

clear

remove

keySet

values

entrySet

toZSONArray

toString