JSONArray (java-sdk-common 1.0.2 API)

java.lang.Object
- cn.iotwasu.hutool.core.getter.OptNullBasicTypeGetter<K>
- - cn.iotwasu.hutool.core.getter.OptNullBasicTypeFromObjectGetter<K>
  - - cn.iotwasu.hutool.json.JSONGetter<Integer>
    - - cn.iotwasu.hutool.json.JSONArray

所有已实现的接口:

BasicTypeGetter<Integer>, OptBasicTypeGetter<Integer>, JSON, Serializable, Cloneable, Iterable<Object>, Collection<Object>, List<Object>, RandomAccess
```
public class JSONArray
extends JSONGetter<Integer>
implements JSON, List<Object>, RandomAccess
```
JSON数组
JSON数组是表示中括号括住的数据表现形式
对应的JSON字符串格格式例如:
```
 ["a", "b", "c", 12]
 
```
作者:

looly

另请参阅:

序列化表格

字段概要

字段
限定符和类型字段和说明

static int DEFAULT_CAPACITY
默认初始大小

字段
限定符和类型	字段和说明
`static int`	`DEFAULT_CAPACITY` 默认初始大小

构造器概要

构造器
构造器和说明
`JSONArray()` 构造默认使用`ArrayList` 实现
`JSONArray(CharSequence source)` 从String构造（JSONArray字符串）
`JSONArray(Collection<Object> list)` 构造将参数数组中的元素转换为JSON对应的对象加入到JSONArray中
`JSONArray(int initialCapacity)` 构造默认使用`ArrayList` 实现
`JSONArray(int initialCapacity, JSONConfig config)` 构造默认使用`ArrayList` 实现
`JSONArray(Iterable<Object> list)` 构造将参数数组中的元素转换为JSON对应的对象加入到JSONArray中
`JSONArray(JSONConfig config)` 构造默认使用`ArrayList` 实现
`JSONArray(JSONTokener x)` 使用 `JSONTokener` 做为参数构造
`JSONArray(Object object)` 从对象构造，忽略`null`的值支持以下类型的参数： 1.
`JSONArray(Object object, boolean ignoreNullValue)` 从对象构造支持以下类型的参数： 1.
`JSONArray(Object object, JSONConfig jsonConfig)` 从对象构造支持以下类型的参数： 1.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`add(int index, Object element)`
`boolean`	`add(Object e)`
`boolean`	`addAll(Collection<?> c)`
`boolean`	`addAll(int index, Collection<?> c)`
`void`	`clear()`
`boolean`	`contains(Object o)`
`boolean`	`containsAll(Collection<?> c)`
`boolean`	`equals(Object obj)`
`Object`	`get(int index)`
`Object`	`getByPath(String expression)` 通过表达式获取JSON中嵌套的对象 .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值 []表达式，可以获取集合等对象中对应index的值表达式栗子： persion persion.name persons[3] person.friends[5].name
`<T> T`	`getByPath(String expression, Class<T> resultType)` 通过表达式获取JSON中嵌套的对象 .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值 []表达式，可以获取集合等对象中对应index的值表达式栗子： persion persion.name persons[3] person.friends[5].name 获取表达式对应值后转换为对应类型的值
`Object`	`getObj(Integer index, Object defaultValue)` 获取Object属性值
`int`	`hashCode()`
`int`	`indexOf(Object o)`
`boolean`	`isEmpty()`
`Iterator<Object>`	`iterator()`
`String`	`join(String separator)` JSONArray转为以`separator`为分界符的字符串
`Iterable<JSONObject>`	`jsonIter()` 当此JSON列表的每个元素都是一个JSONObject时，可以调用此方法返回一个Iterable，便于使用foreach语法遍历
`int`	`lastIndexOf(Object o)`
`ListIterator<Object>`	`listIterator()`
`ListIterator<Object>`	`listIterator(int index)`
`JSONArray`	`put(int index, Object value)` 加入或者替换JSONArray中指定Index的值，如果index大于JSONArray的长度，将在指定index设置值，之前的位置填充JSONNull.Null
`JSONArray`	`put(Object value)` Append an object value.
`void`	`putByPath(String expression, Object value)` 设置表达式指定位置（或filed对应）的值若表达式指向一个JSONArray则设置其坐标对应位置的值，若指向JSONObject则put对应key的值注意：如果为JSONArray，设置值下标小于其长度，将替换原有值，否则追加新值 .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值 []表达式，可以获取集合等对象中对应index的值表达式栗子： persion persion.name persons[3] person.friends[5].name
`Object`	`remove(int index)`
`boolean`	`remove(Object o)`
`boolean`	`removeAll(Collection<?> c)`
`boolean`	`retainAll(Collection<?> c)`
`Object`	`set(int index, Object element)`
`JSONArray`	`setDateFormat(String format)` 设置转为字符串时的日期格式，默认为时间戳（null值）
`int`	`size()`
`List<Object>`	`subList(int fromIndex, int toIndex)`
`Object[]`	`toArray()`
`Object`	`toArray(Class<?> arrayClass)` 转为Bean数组
`<T> T[]`	`toArray(T[] a)`
`JSONObject`	`toJSONObject(JSONArray names)` 根据给定名列表，与其位置对应的值组成JSONObject
`String`	`toJSONString(int indentFactor)` 转为JSON字符串，指定缩进值
`<T> List<T>`	`toList(Class<T> elementType)` 转为`ArrayList`
`String`	`toString()` 转为JSON字符串，无缩进
`String`	`toStringPretty()` 格式化打印JSON，缩进为4个空格
`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.

从类继承的方法 cn.iotwasu.hutool.json.JSONGetter
get, get, getBean, getJSONArray, getJSONObject, getStrEscaped, getStrEscaped, isNull

从类继承的方法 cn.iotwasu.hutool.core.getter.OptNullBasicTypeFromObjectGetter
getBigDecimal, getBigInteger, getBool, getByte, getChar, getDate, getDouble, getEnum, getFloat, getInt, getLong, getShort, getStr

从类继承的方法 cn.iotwasu.hutool.core.getter.OptNullBasicTypeGetter
getBigDecimal, getBigInteger, getBool, getByte, getChar, getDate, getDouble, getEnum, getFloat, getInt, getLong, getObj, getShort, getStr

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

从接口继承的方法 java.util.List
replaceAll, sort, spliterator

从接口继承的方法 java.util.Collection
parallelStream, removeIf, stream

从接口继承的方法 java.lang.Iterable
forEach

- 字段详细资料
  - DEFAULT_CAPACITY
```
public static final int DEFAULT_CAPACITY
```
    默认初始大小
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - JSONArray
```
public JSONArray()
```
    构造
    默认使用ArrayList 实现
  - JSONArray
```
public JSONArray(int initialCapacity)
```
    构造
    默认使用ArrayList 实现
    
    参数:
    
    initialCapacity - 初始大小
    
    从以下版本开始:
    
    3.2.2
  - JSONArray
```
public JSONArray(JSONConfig config)
```
    构造
    默认使用ArrayList 实现
    
    参数:
    
    config - JSON配置项
    
    从以下版本开始:
    
    4.6.5
  - JSONArray
```
public JSONArray(int initialCapacity,
                 JSONConfig config)
```
    构造
    默认使用ArrayList 实现
    
    参数:
    
    initialCapacity - 初始大小
    
    config - JSON配置项
    
    从以下版本开始:
    
    4.1.19
  - JSONArray
```
public JSONArray(Iterable<Object> list)
```
    构造
    将参数数组中的元素转换为JSON对应的对象加入到JSONArray中
    
    参数:
    
    list - 初始化的JSON数组
  - JSONArray
```
public JSONArray(Collection<Object> list)
```
    构造
    将参数数组中的元素转换为JSON对应的对象加入到JSONArray中
    
    参数:
    
    list - 初始化的JSON数组
  - JSONArray
```
public JSONArray(JSONTokener x)
          throws JSONException
```
    使用 JSONTokener 做为参数构造
    
    参数:
    
    x - A JSONTokener
    
    抛出:
    
    JSONException - If there is a syntax error.
  - JSONArray
```
public JSONArray(CharSequence source)
          throws JSONException
```
    从String构造（JSONArray字符串）
    
    参数:
    
    source - JSON数组字符串
    
    抛出:
    
    JSONException - If there is a syntax error.
  - JSONArray
```
public JSONArray(Object object)
          throws JSONException
```
    从对象构造，忽略null的值
    支持以下类型的参数：
```
 1. 数组
 2. Iterable对象
 3. JSON数组字符串
 
```
    参数:
    
    object - 数组或集合或JSON数组字符串
    
    抛出:
    
    JSONException - 非数组或集合
  - JSONArray
```
public JSONArray(Object object,
                 boolean ignoreNullValue)
          throws JSONException
```
    从对象构造
    支持以下类型的参数：
```
 1. 数组
 2. Iterable对象
 3. JSON数组字符串
 
```
    参数:
    
    object - 数组或集合或JSON数组字符串
    
    ignoreNullValue - 是否忽略空值
    
    抛出:
    
    JSONException - 非数组或集合
  - JSONArray
```
public JSONArray(Object object,
                 JSONConfig jsonConfig)
          throws JSONException
```
    从对象构造
    支持以下类型的参数：
```
 1. 数组
 2. Iterable对象
 3. JSON数组字符串
 
```
    参数:
    
    object - 数组或集合或JSON数组字符串
    
    jsonConfig - JSON选项
    
    抛出:
    
    JSONException - 非数组或集合
    
    从以下版本开始:
    
    4.6.5
- 方法详细资料
  - setDateFormat
```
public JSONArray setDateFormat(String format)
```
    设置转为字符串时的日期格式，默认为时间戳（null值）
    
    参数:
    
    format - 格式，null表示使用时间戳
    
    返回:
    
    this
    
    从以下版本开始:
    
    4.1.19
  - join
```
public String join(String separator)
            throws JSONException
```
    JSONArray转为以separator为分界符的字符串
    
    参数:
    
    separator - 分界符
    
    返回:
    
    a string.
    
    抛出:
    
    JSONException - If the array contains an invalid number.
  - get
```
public Object get(int index)
```
    指定者:
    
    get 在接口中 List<Object>
  - getObj
```
public Object getObj(Integer index,
                     Object defaultValue)
```
    从接口复制的说明: OptBasicTypeGetter
    
    获取Object属性值
    
    指定者:
    
    getObj 在接口中 OptBasicTypeGetter<Integer>
    
    指定者:
    
    getObj 在类中 OptNullBasicTypeFromObjectGetter<Integer>
    
    参数:
    
    index - 属性名
    
    defaultValue - 默认值
    
    返回:
    
    属性值，无对应值返回defaultValue
  - getByPath
```
public Object getByPath(String expression)
```
    从接口复制的说明: JSON
    通过表达式获取JSON中嵌套的对象
    1. .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
    2. []表达式，可以获取集合等对象中对应index的值
    表达式栗子：
```
 persion
 persion.name
 persons[3]
 person.friends[5].name
 
```
    指定者:
    
    getByPath 在接口中 JSON
    
    参数:
    
    expression - 表达式
    
    返回:
    
    对象
    
    另请参阅:
    
    BeanPath.get(Object)
  - getByPath
```
public <T> T getByPath(String expression,
                       Class<T> resultType)
```
    从接口复制的说明: JSON
    通过表达式获取JSON中嵌套的对象
    1. .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
    2. []表达式，可以获取集合等对象中对应index的值
    表达式栗子：
```
 persion
 persion.name
 persons[3]
 person.friends[5].name
 
```
    获取表达式对应值后转换为对应类型的值
    指定者:
    
    getByPath 在接口中 JSON
    
    类型参数:
    
    T - 返回值类型
    
    参数:
    
    expression - 表达式
    
    resultType - 返回值类型
    
    返回:
    
    对象
    
    另请参阅:
    
    BeanPath.get(Object)
  - putByPath
```
public void putByPath(String expression,
                      Object value)
```
    从接口复制的说明: JSON
    设置表达式指定位置（或filed对应）的值
    若表达式指向一个JSONArray则设置其坐标对应位置的值，若指向JSONObject则put对应key的值
    注意：如果为JSONArray，设置值下标小于其长度，将替换原有值，否则追加新值
    1. .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
    2. []表达式，可以获取集合等对象中对应index的值
    表达式栗子：
```
 persion
 persion.name
 persons[3]
 person.friends[5].name
 
```
    指定者:
    
    putByPath 在接口中 JSON
    
    参数:
    
    expression - 表达式
    
    value - 值
  - put
```
public JSONArray put(Object value)
```
    Append an object value. This increases the array's length by one.
    加入元素，数组长度+1，等同于 add(Object)
    
    参数:
    
    value - 值，可以是： Boolean, Double, Integer, JSONArray, JSONObject, Long, or String, or the JSONNull.NULL。
    
    返回:
    
    this.
  - put
```
public JSONArray put(int index,
                     Object value)
              throws JSONException
```
    加入或者替换JSONArray中指定Index的值，如果index大于JSONArray的长度，将在指定index设置值，之前的位置填充JSONNull.Null
    
    参数:
    
    index - 位置
    
    value - 值对象. 可以是以下类型: Boolean, Double, Integer, JSONArray, JSONObject, Long, String, or the JSONNull.NULL.
    
    返回:
    
    this.
    
    抛出:
    
    JSONException - index < 0 或者非有限的数字
  - toJSONObject
```
public JSONObject toJSONObject(JSONArray names)
                        throws JSONException
```
    根据给定名列表，与其位置对应的值组成JSONObject
    
    参数:
    
    names - 名列表，位置与JSONArray中的值位置对应
    
    返回:
    
    A JSONObject，无名或值返回null
    
    抛出:
    
    JSONException - 如果任何一个名为null
  - hashCode
```
public int hashCode()
```
    指定者:
    
    hashCode 在接口中 Collection<Object>
    
    指定者:
    
    hashCode 在接口中 List<Object>
    
    覆盖:
    
    hashCode 在类中 Object
  - equals
```
public boolean equals(Object obj)
```
    指定者:
    
    equals 在接口中 Collection<Object>
    
    指定者:
    
    equals 在接口中 List<Object>
    
    覆盖:
    
    equals 在类中 Object
  - iterator
```
public Iterator<Object> iterator()
```
    指定者:
    
    iterator 在接口中 Iterable<Object>
    
    指定者:
    
    iterator 在接口中 Collection<Object>
    
    指定者:
    
    iterator 在接口中 List<Object>
  - jsonIter
```
public Iterable<JSONObject> jsonIter()
```
    当此JSON列表的每个元素都是一个JSONObject时，可以调用此方法返回一个Iterable，便于使用foreach语法遍历
    
    返回:
    
    Iterable
    
    从以下版本开始:
    
    4.0.12
  - size
```
public int size()
```
    指定者:
    
    size 在接口中 Collection<Object>
    
    指定者:
    
    size 在接口中 List<Object>
  - isEmpty
```
public boolean isEmpty()
```
    指定者:
    
    isEmpty 在接口中 Collection<Object>
    
    指定者:
    
    isEmpty 在接口中 List<Object>
  - contains
```
public boolean contains(Object o)
```
    指定者:
    
    contains 在接口中 Collection<Object>
    
    指定者:
    
    contains 在接口中 List<Object>
  - toArray
```
public Object[] toArray()
```
    指定者:
    
    toArray 在接口中 Collection<Object>
    
    指定者:
    
    toArray 在接口中 List<Object>
  - toArray
```
public <T> T[] toArray(T[] a)
```
    指定者:
    
    toArray 在接口中 Collection<Object>
    
    指定者:
    
    toArray 在接口中 List<Object>
  - add
```
public boolean add(Object e)
```
    指定者:
    
    add 在接口中 Collection<Object>
    
    指定者:
    
    add 在接口中 List<Object>
  - remove
```
public Object remove(int index)
```
    指定者:
    
    remove 在接口中 List<Object>
  - remove
```
public boolean remove(Object o)
```
    指定者:
    
    remove 在接口中 Collection<Object>
    
    指定者:
    
    remove 在接口中 List<Object>
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    指定者:
    
    containsAll 在接口中 Collection<Object>
    
    指定者:
    
    containsAll 在接口中 List<Object>
  - addAll
```
public boolean addAll(Collection<?> c)
```
    指定者:
    
    addAll 在接口中 Collection<Object>
    
    指定者:
    
    addAll 在接口中 List<Object>
  - addAll
```
public boolean addAll(int index,
                      Collection<?> c)
```
    指定者:
    
    addAll 在接口中 List<Object>
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    指定者:
    
    removeAll 在接口中 Collection<Object>
    
    指定者:
    
    removeAll 在接口中 List<Object>
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    指定者:
    
    retainAll 在接口中 Collection<Object>
    
    指定者:
    
    retainAll 在接口中 List<Object>
  - clear
```
public void clear()
```
    指定者:
    
    clear 在接口中 Collection<Object>
    
    指定者:
    
    clear 在接口中 List<Object>
  - set
```
public Object set(int index,
                  Object element)
```
    指定者:
    
    set 在接口中 List<Object>
  - add
```
public void add(int index,
                Object element)
```
    指定者:
    
    add 在接口中 List<Object>
  - indexOf
```
public int indexOf(Object o)
```
    指定者:
    
    indexOf 在接口中 List<Object>
  - lastIndexOf
```
public int lastIndexOf(Object o)
```
    指定者:
    
    lastIndexOf 在接口中 List<Object>
  - listIterator
```
public ListIterator<Object> listIterator()
```
    指定者:
    
    listIterator 在接口中 List<Object>
  - listIterator
```
public ListIterator<Object> listIterator(int index)
```
    指定者:
    
    listIterator 在接口中 List<Object>
  - subList
```
public List<Object> subList(int fromIndex,
                            int toIndex)
```
    指定者:
    
    subList 在接口中 List<Object>
  - toArray
```
public Object toArray(Class<?> arrayClass)
```
    转为Bean数组
    
    参数:
    
    arrayClass - 数组元素类型
    
    返回:
    
    实体类对象
  - toList
```
public <T> List<T> toList(Class<T> elementType)
```
    转为ArrayList
    
    类型参数:
    
    T - 元素类型
    
    参数:
    
    elementType - 元素类型
    
    返回:
    
    ArrayList
    
    从以下版本开始:
    
    3.0.8
  - toString
```
public String toString()
```
    转为JSON字符串，无缩进
    
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    JSONArray字符串
  - toStringPretty
```
public String toStringPretty()
                      throws JSONException
```
    格式化打印JSON，缩进为4个空格
    
    指定者:
    
    toStringPretty 在接口中 JSON
    
    返回:
    
    格式化后的JSON字符串
    
    抛出:
    
    JSONException - 包含非法数抛出此异常
    
    从以下版本开始:
    
    3.0.9
  - toJSONString
```
public String toJSONString(int indentFactor)
                    throws JSONException
```
    转为JSON字符串，指定缩进值
    
    指定者:
    
    toJSONString 在接口中 JSON
    
    参数:
    
    indentFactor - 缩进值，即缩进空格数
    
    返回:
    
    JSON字符串
    
    抛出:
    
    JSONException - JSON写入异常
  - 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 - JSON相关异常
  - 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 - JSON相关异常

类 JSONArray

字段概要

构造器概要

方法概要

从类继承的方法 cn.iotwasu.hutool.json.JSONGetter

从类继承的方法 cn.iotwasu.hutool.core.getter.OptNullBasicTypeFromObjectGetter

从类继承的方法 cn.iotwasu.hutool.core.getter.OptNullBasicTypeGetter

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

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

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

从接口继承的方法 java.lang.Iterable

字段详细资料

DEFAULT_CAPACITY

构造器详细资料

JSONArray

JSONArray

JSONArray

JSONArray

JSONArray

JSONArray

JSONArray

JSONArray

JSONArray

JSONArray

JSONArray

方法详细资料

setDateFormat

join

get

getObj

getByPath

getByPath

putByPath

put

put

toJSONObject

hashCode

equals

iterator

jsonIter

size

isEmpty

contains

toArray

toArray

add

remove

remove

containsAll

addAll

addAll

removeAll

retainAll

clear

set

add

indexOf

lastIndexOf

listIterator

listIterator

subList

toArray

toList

toString

toStringPretty

toJSONString

write

write