JSONArray (hutool 5.8.33 API)

java.lang.Object
- cn.hutool.json.JSONArray

All Implemented Interfaces:

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

looly

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_CAPACITY
默认初始大小

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

Constructor Summary

Constructors
Constructor and Description
`JSONArray()` 构造默认使用`ArrayList` 实现
`JSONArray(int initialCapacity)` 构造默认使用`ArrayList` 实现
`JSONArray(int initialCapacity, JSONConfig config)` 构造默认使用`ArrayList` 实现
`JSONArray(JSONConfig config)` 构造默认使用`ArrayList` 实现
`JSONArray(Object object)` 从对象构造，忽略`null`的值支持以下类型的参数： 1.
`JSONArray(Object object, boolean ignoreNullValue)` 从对象构造支持以下类型的参数： 1.
`JSONArray(Object object, JSONConfig jsonConfig)` 从对象构造支持以下类型的参数： 1.
`JSONArray(Object object, JSONConfig jsonConfig, Filter<Mutable<Object>> filter)` 从对象构造支持以下类型的参数： 1.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(int index, Object element)`
`boolean`	`add(Object e)`
`boolean`	`addAll(Collection<?> c)`
`boolean`	`addAll(int index, Collection<?> c)`
`protected boolean`	`addRaw(Object obj, Filter<Mutable<Object>> filter)` 原始添加，添加的对象不做任何处理
`void`	`clear()`
`Object`	`clone()`
`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 获取表达式对应值后转换为对应类型的值
`JSONConfig`	`getConfig()` 获取JSON配置
`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中指定Index的值，如果index大于JSONArray的长度，将在指定index设置值，之前的位置填充JSONNull.Null
`Object`	`set(int index, Object element, Filter<MutablePair<Integer,Object>> filter)` 加入或者替换JSONArray中指定Index的值，如果index大于JSONArray的长度，将在指定index设置值，之前的位置填充JSONNull.Null
`JSONArray`	`set(Object value)` Append an object value.
`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, Filter<MutablePair<Object,Object>> filter)` 返回JSON字符串支持过滤器，即选择哪些字段或值不写出
`<T> List<T>`	`toList(Class<T> elementType)` 转为`ArrayList`
`String`	`toString()` 转为JSON字符串，无缩进
`Writer`	`write(Writer writer, int indentFactor, int indent)` 将JSON内容写入Writer Warning: This method assumes that the data structure is acyclical.
`Writer`	`write(Writer writer, int indentFactor, int indent, Filter<MutablePair<Object,Object>> filter)` 将JSON内容写入Writer 支持过滤器，即选择哪些字段或值不写出

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

Methods inherited from interface cn.hutool.json.JSON
toBean, toBean, toBean, toBean, toJSONString, toStringPretty, write

Methods inherited from interface cn.hutool.json.JSONGetter
get, get, getBean, getBeanList, getBytes, getDate, getJSONArray, getJSONObject, getLocalDateTime, getStrEscaped, getStrEscaped, isNull

Methods inherited from interface cn.hutool.core.getter.OptNullBasicTypeFromObjectGetter
getBigDecimal, getBigInteger, getBool, getByte, getChar, getDouble, getEnum, getFloat, getInt, getLong, getShort, getStr

Methods inherited from interface cn.hutool.core.getter.OptNullBasicTypeGetter
getBigDecimal, getBigInteger, getBool, getByte, getChar, getDate, getDouble, getEnum, getFloat, getInt, getLong, getObj, getShort, getStr

Methods inherited from interface java.util.List
replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

- Field Detail
  - DEFAULT_CAPACITY
```
public static final int DEFAULT_CAPACITY
```
    默认初始大小
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JSONArray
```
public JSONArray()
```
    构造
    默认使用ArrayList 实现
  - JSONArray
```
public JSONArray(int initialCapacity)
```
    构造
    默认使用ArrayList 实现
    
    Parameters:
    
    initialCapacity - 初始大小
    
    Since:
    
    3.2.2
  - JSONArray
```
public JSONArray(JSONConfig config)
```
    构造
    默认使用ArrayList 实现
    
    Parameters:
    
    config - JSON配置项
    
    Since:
    
    4.6.5
  - JSONArray
```
public JSONArray(int initialCapacity,
                 JSONConfig config)
```
    构造
    默认使用ArrayList 实现
    
    Parameters:
    
    initialCapacity - 初始大小
    
    config - JSON配置项
    
    Since:
    
    4.1.19
  - JSONArray
```
public JSONArray(Object object)
          throws JSONException
```
    从对象构造，忽略null的值
    支持以下类型的参数：
```
 1. 数组
 2. Iterable对象
 3. JSON数组字符串
 
```
    Parameters:
    
    object - 数组或集合或JSON数组字符串
    
    Throws:
    
    JSONException - 非数组或集合
  - JSONArray
```
public JSONArray(Object object,
                 boolean ignoreNullValue)
          throws JSONException
```
    从对象构造
    支持以下类型的参数：
```
 1. 数组
 2. Iterable对象
 3. JSON数组字符串
 
```
    Parameters:
    
    object - 数组或集合或JSON数组字符串
    
    ignoreNullValue - 是否忽略空值
    
    Throws:
    
    JSONException - 非数组或集合
  - JSONArray
```
public JSONArray(Object object,
                 JSONConfig jsonConfig)
          throws JSONException
```
    从对象构造
    支持以下类型的参数：
```
 1. 数组
 2. Iterable对象
 3. JSON数组字符串
 
```
    Parameters:
    
    object - 数组或集合或JSON数组字符串
    
    jsonConfig - JSON选项
    
    Throws:
    
    JSONException - 非数组或集合
    
    Since:
    
    4.6.5
  - JSONArray
```
public JSONArray(Object object,
                 JSONConfig jsonConfig,
                 Filter<Mutable<Object>> filter)
          throws JSONException
```
    从对象构造
    支持以下类型的参数：
```
 1. 数组
 2. Iterable对象
 3. JSON数组字符串
 
```
    Parameters:
    
    object - 数组或集合或JSON数组字符串
    
    jsonConfig - JSON选项
    
    filter - 键值对过滤编辑器，可以通过实现此接口，完成解析前对值的过滤和修改操作，null表示不过滤
    
    Throws:
    
    JSONException - 非数组或集合
    
    Since:
    
    5.8.0
- Method Detail
  - getConfig
```
public JSONConfig getConfig()
```
    Description copied from interface: JSON
    
    获取JSON配置
    
    Specified by:
    
    getConfig in interface JSON
    
    Specified by:
    
    getConfig in interface JSONGetter<Integer>
    
    Returns:
    
    JSONConfig
  - setDateFormat
```
public JSONArray setDateFormat(String format)
```
    设置转为字符串时的日期格式，默认为时间戳（null值）
    
    Parameters:
    
    format - 格式，null表示使用时间戳
    
    Returns:
    
    this
    
    Since:
    
    4.1.19
  - join
```
public String join(String separator)
            throws JSONException
```
    JSONArray转为以separator为分界符的字符串
    
    Parameters:
    
    separator - 分界符
    
    Returns:
    
    a string.
    
    Throws:
    
    JSONException - If the array contains an invalid number.
  - get
```
public Object get(int index)
```
    Specified by:
    
    get in interface List<Object>
  - getObj
```
public Object getObj(Integer index,
                     Object defaultValue)
```
    Description copied from interface: OptBasicTypeGetter
    
    获取Object属性值
    
    Specified by:
    
    getObj in interface OptBasicTypeGetter<Integer>
    
    Parameters:
    
    index - 属性名
    
    defaultValue - 默认值
    
    Returns:
    
    属性值，无对应值返回defaultValue
  - getByPath
```
public Object getByPath(String expression)
```
    Description copied from interface: JSON
    通过表达式获取JSON中嵌套的对象
    1. .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
    2. []表达式，可以获取集合等对象中对应index的值
    表达式栗子：
```
 persion
 persion.name
 persons[3]
 person.friends[5].name
 
```
    Specified by:
    
    getByPath in interface JSON
    
    Parameters:
    
    expression - 表达式
    
    Returns:
    
    对象
    
    See Also:
    
    BeanPath.get(Object)
  - getByPath
```
public <T> T getByPath(String expression,
                       Class<T> resultType)
```
    Description copied from interface: JSON
    通过表达式获取JSON中嵌套的对象
    1. .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
    2. []表达式，可以获取集合等对象中对应index的值
    表达式栗子：
```
 persion
 persion.name
 persons[3]
 person.friends[5].name
 
```
    获取表达式对应值后转换为对应类型的值
    Specified by:
    
    getByPath in interface JSON
    
    Type Parameters:
    
    T - 返回值类型
    
    Parameters:
    
    expression - 表达式
    
    resultType - 返回值类型
    
    Returns:
    
    对象
    
    See Also:
    
    BeanPath.get(Object)
  - putByPath
```
public void putByPath(String expression,
                      Object value)
```
    Description copied from interface: JSON
    设置表达式指定位置（或filed对应）的值
    若表达式指向一个JSONArray则设置其坐标对应位置的值，若指向JSONObject则put对应key的值
    注意：如果为JSONArray，设置值下标小于其长度，将替换原有值，否则追加新值
    1. .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
    2. []表达式，可以获取集合等对象中对应index的值
    表达式栗子：
```
 persion
 persion.name
 persons[3]
 person.friends[5].name
 
```
    Specified by:
    
    putByPath in interface JSON
    
    Parameters:
    
    expression - 表达式
    
    value - 值
  - put
```
public JSONArray put(Object value)
```
    Append an object value. This increases the array's length by one.
    加入元素，数组长度+1，等同于 add(Object)
    
    Parameters:
    
    value - 值，可以是： Boolean, Double, Integer, JSONArray, JSONObject, Long, or String, or the JSONNull.NULL。
    
    Returns:
    
    this.
    
    See Also:
    
    set(Object)
  - set
```
public JSONArray set(Object value)
```
    Append an object value. This increases the array's length by one.
    加入元素，数组长度+1，等同于 add(Object)
    
    Parameters:
    
    value - 值，可以是： Boolean, Double, Integer, JSONArray, JSONObject, Long, or String, or the JSONNull.NULL。
    
    Returns:
    
    this.
    
    Since:
    
    5.2.5
  - put
```
public JSONArray put(int index,
                     Object value)
              throws JSONException
```
    加入或者替换JSONArray中指定Index的值，如果index大于JSONArray的长度，将在指定index设置值，之前的位置填充JSONNull.Null
    
    Parameters:
    
    index - 位置
    
    value - 值对象. 可以是以下类型: Boolean, Double, Integer, JSONArray, JSONObject, Long, String, or the JSONNull.NULL.
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - index < 0 或者非有限的数字
    
    See Also:
    
    set(int, Object)
  - toJSONObject
```
public JSONObject toJSONObject(JSONArray names)
                        throws JSONException
```
    根据给定名列表，与其位置对应的值组成JSONObject
    
    Parameters:
    
    names - 名列表，位置与JSONArray中的值位置对应
    
    Returns:
    
    A JSONObject，无名或值返回null
    
    Throws:
    
    JSONException - 如果任何一个名为null
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Collection<Object>
    
    Specified by:
    
    hashCode in interface List<Object>
    
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in interface Collection<Object>
    
    Specified by:
    
    equals in interface List<Object>
    
    Overrides:
    
    equals in class Object
  - iterator
```
public Iterator<Object> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Object>
    
    Specified by:
    
    iterator in interface Collection<Object>
    
    Specified by:
    
    iterator in interface List<Object>
  - jsonIter
```
public Iterable<JSONObject> jsonIter()
```
    当此JSON列表的每个元素都是一个JSONObject时，可以调用此方法返回一个Iterable，便于使用foreach语法遍历
    
    Returns:
    
    Iterable
    
    Since:
    
    4.0.12
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection<Object>
    
    Specified by:
    
    size in interface List<Object>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Collection<Object>
    
    Specified by:
    
    isEmpty in interface List<Object>
  - contains
```
public boolean contains(Object o)
```
    Specified by:
    
    contains in interface Collection<Object>
    
    Specified by:
    
    contains in interface List<Object>
  - toArray
```
public Object[] toArray()
```
    Specified by:
    
    toArray in interface Collection<Object>
    
    Specified by:
    
    toArray in interface List<Object>
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Specified by:
    
    toArray in interface Collection<Object>
    
    Specified by:
    
    toArray in interface List<Object>
  - add
```
public boolean add(Object e)
```
    Specified by:
    
    add in interface Collection<Object>
    
    Specified by:
    
    add in interface List<Object>
  - remove
```
public Object remove(int index)
```
    Specified by:
    
    remove in interface List<Object>
  - remove
```
public boolean remove(Object o)
```
    Specified by:
    
    remove in interface Collection<Object>
    
    Specified by:
    
    remove in interface List<Object>
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    Specified by:
    
    containsAll in interface Collection<Object>
    
    Specified by:
    
    containsAll in interface List<Object>
  - addAll
```
public boolean addAll(Collection<?> c)
```
    Specified by:
    
    addAll in interface Collection<Object>
    
    Specified by:
    
    addAll in interface List<Object>
  - addAll
```
public boolean addAll(int index,
                      Collection<?> c)
```
    Specified by:
    
    addAll in interface List<Object>
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    Specified by:
    
    removeAll in interface Collection<Object>
    
    Specified by:
    
    removeAll in interface List<Object>
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    Specified by:
    
    retainAll in interface Collection<Object>
    
    Specified by:
    
    retainAll in interface List<Object>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Collection<Object>
    
    Specified by:
    
    clear in interface List<Object>
  - set
```
public Object set(int index,
                  Object element)
```
    加入或者替换JSONArray中指定Index的值，如果index大于JSONArray的长度，将在指定index设置值，之前的位置填充JSONNull.Null
    
    Specified by:
    
    set in interface List<Object>
    
    Parameters:
    
    index - 位置
    
    element - 值对象. 可以是以下类型: Boolean, Double, Integer, JSONArray, JSONObject, Long, String, or the JSONNull.NULL.
    
    Returns:
    
    替换的值，即之前的值
  - set
```
public Object set(int index,
                  Object element,
                  Filter<MutablePair<Integer,Object>> filter)
```
    加入或者替换JSONArray中指定Index的值，如果index大于JSONArray的长度，将在指定index设置值，之前的位置填充JSONNull.Null
    
    Parameters:
    
    index - 位置
    
    element - 值对象. 可以是以下类型: Boolean, Double, Integer, JSONArray, JSONObject, Long, String, or the JSONNull.NULL.
    
    filter - 过滤器，可以修改值，key（index）无法修改
    
    Returns:
    
    替换的值，即之前的值
    
    Since:
    
    5.8.0
  - add
```
public void add(int index,
                Object element)
```
    Specified by:
    
    add in interface List<Object>
  - indexOf
```
public int indexOf(Object o)
```
    Specified by:
    
    indexOf in interface List<Object>
  - lastIndexOf
```
public int lastIndexOf(Object o)
```
    Specified by:
    
    lastIndexOf in interface List<Object>
  - listIterator
```
public ListIterator<Object> listIterator()
```
    Specified by:
    
    listIterator in interface List<Object>
  - listIterator
```
public ListIterator<Object> listIterator(int index)
```
    Specified by:
    
    listIterator in interface List<Object>
  - subList
```
public List<Object> subList(int fromIndex,
                            int toIndex)
```
    Specified by:
    
    subList in interface List<Object>
  - toArray
```
public Object toArray(Class<?> arrayClass)
```
    转为Bean数组
    
    Parameters:
    
    arrayClass - 数组元素类型
    
    Returns:
    
    实体类对象
  - toList
```
public <T> List<T> toList(Class<T> elementType)
```
    转为ArrayList
    
    Type Parameters:
    
    T - 元素类型
    
    Parameters:
    
    elementType - 元素类型
    
    Returns:
    
    ArrayList
    
    Since:
    
    3.0.8
  - toString
```
public String toString()
```
    转为JSON字符串，无缩进
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    JSONArray字符串
  - toJSONString
```
public String toJSONString(int indentFactor,
                           Filter<MutablePair<Object,Object>> filter)
```
    返回JSON字符串
    支持过滤器，即选择哪些字段或值不写出
    
    Parameters:
    
    indentFactor - 每层缩进空格数
    
    filter - 过滤器，可以修改值，key（index）无法修改
    
    Returns:
    
    JSON字符串
    
    Since:
    
    5.7.15
  - write
```
public Writer write(Writer writer,
                    int indentFactor,
                    int indent)
             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
    
    indentFactor - 缩进因子，定义每一级别增加的缩进量
    
    indent - 本级别缩进量
    
    Returns:
    
    Writer
    
    Throws:
    
    JSONException - JSON相关异常
  - write
```
public Writer write(Writer writer,
                    int indentFactor,
                    int indent,
                    Filter<MutablePair<Object,Object>> filter)
             throws JSONException
```
    将JSON内容写入Writer
    支持过滤器，即选择哪些字段或值不写出
    
    Parameters:
    
    writer - writer
    
    indentFactor - 缩进因子，定义每一级别增加的缩进量
    
    indent - 本级别缩进量
    
    filter - 过滤器，可以修改值，key（index）无法修改
    
    Returns:
    
    Writer
    
    Throws:
    
    JSONException - JSON相关异常
    
    Since:
    
    5.7.15
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException
  - addRaw
```
protected boolean addRaw(Object obj,
                         Filter<Mutable<Object>> filter)
```
    原始添加，添加的对象不做任何处理
    
    Parameters:
    
    obj - 添加的对象
    
    filter - 键值对过滤编辑器，可以通过实现此接口，完成解析前对值的过滤和修改操作，null表示不过滤
    
    Returns:
    
    是否加入成功
    
    Since:
    
    5.8.0

Class JSONArray

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface cn.hutool.json.JSON

Methods inherited from interface cn.hutool.json.JSONGetter

Methods inherited from interface cn.hutool.core.getter.OptNullBasicTypeFromObjectGetter

Methods inherited from interface cn.hutool.core.getter.OptNullBasicTypeGetter

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Field Detail

DEFAULT_CAPACITY

Constructor Detail

JSONArray

JSONArray

JSONArray

JSONArray

JSONArray

JSONArray

JSONArray

JSONArray

Method Detail

getConfig

setDateFormat

join

get

getObj

getByPath

getByPath

putByPath

put

set

put

toJSONObject

hashCode

equals

iterator

jsonIter

size

isEmpty

contains

toArray

toArray

add

remove

remove

containsAll

addAll

addAll

removeAll

retainAll

clear

set

set

add

indexOf

lastIndexOf

listIterator

listIterator

subList

toArray

toList

toString

toJSONString

write

write

clone

addRaw