JSONArray (hutool 2.15.9 API)

java.lang.Object
- com.xiaoleilu.hutool.getter.OptNullBasicTypeGetter<K>
- - com.xiaoleilu.hutool.getter.OptNullBasicTypeFromObjectGetter<Integer>
  - - com.xiaoleilu.hutool.json.JSONArray

所有已实现的接口:

BasicTypeGetter<Integer>, OptBasicTypeGetter<Integer>, JSON, Iterable<Object>
```
public class JSONArray
extends OptNullBasicTypeFromObjectGetter<Integer>
implements JSON, Iterable<Object>
```
A JSONArray is an ordered sequence of values. Its external text form is a string wrapped in square brackets with commas separating the values. The internal form is an object having get and opt methods for accessing the values by index, and put methods for adding or replacing values. The values can be any of these types: Boolean, JSONArray, JSONObject, Number, String, or the JSONNull.NULL object.
The constructor can convert a JSON text into a Java object. The toString method converts to JSON text.
A get method returns a value if one can be found, and throws an exception if one cannot be found. An opt method returns a default value instead of throwing an exception, and so is useful for obtaining optional values.
The generic get() and opt() methods return an object which you can cast or query for type. There are also typed get and opt methods that do type checking and type coercion for you.
The texts produced by the toString methods strictly conform to JSON syntax rules. The constructors are more forgiving in the texts they will accept:
- An extra , (comma) may appear just before the closing bracket.
- The null value will be inserted when there is , (comma) elision.
- Strings may be quoted with ' (single quote).
- Strings do not need to be quoted at all if they do not begin with a quote or single quote, and if they do not contain leading or trailing spaces, and if they do not contain any of these characters: { } [ ] / \ : , # and if they do not look like numbers and if they are not the reserved words true, false, or null.
版本:

2015-10-29

作者:

JSON.org

构造器概要

构造器
构造器和说明
`JSONArray()` Construct an empty JSONArray.
`JSONArray(JSONTokener x)` Construct a JSONArray from a JSONTokener.
`JSONArray(Object arrayOrCollection)` Construct a JSONArray from an array or Collection
`JSONArray(String source)` Construct a JSONArray from a source JSON text.

方法概要

方法
限定符和类型	方法和说明
`Object`	`get(int index)` Get the optional object value associated with an index.
`<E extends Enum<E>> E`	`getEnum(Class<E> clazz, int index)` Get the enum value associated with a key.
`<E extends Enum<E>> E`	`getEnum(Class<E> clazz, int index, E defaultValue)` Get the enum value associated with a key.
`JSONArray`	`getJSONArray(int index)` Get the optional JSONArray associated with an index.
`JSONObject`	`getJSONObject(int index)` Get the optional JSONObject associated with an index.
`Object`	`getObj(Integer index, Object defaultValue)` 获取Object属性值
`boolean`	`isNull(int index)` Determine if the value is null.
`Iterator<Object>`	`iterator()`
`String`	`join(String separator)` Make a string from the contents of this JSONArray.
`int`	`length()` Get the number of elements in the JSONArray, included nulls.
`JSONArray`	`put(boolean value)` Append a boolean value.
`JSONArray`	`put(Collection<?> value)` Put a value in the JSONArray, where the value will be a JSONArray which is produced from a Collection.
`JSONArray`	`put(double value)` Append a double value.
`JSONArray`	`put(int value)` Append an int value.
`JSONArray`	`put(int index, boolean value)` Put or replace a boolean value in the JSONArray.
`JSONArray`	`put(int index, Collection<?> value)` Put a value in the JSONArray, where the value will be a JSONArray which is produced from a Collection.
`JSONArray`	`put(int index, double value)` Put or replace a double value.
`JSONArray`	`put(int index, int value)` Put or replace an int value.
`JSONArray`	`put(int index, long value)` Put or replace a long value.
`JSONArray`	`put(int index, Map<?,?> value)` Put a value in the JSONArray, where the value will be a JSONObject that is produced from a Map.
`JSONArray`	`put(int index, Object value)` Put or replace an object value in the JSONArray.
`JSONArray`	`put(long value)` Append an long value.
`JSONArray`	`put(Map<?,?> value)` Put a value in the JSONArray, where the value will be a JSONObject which is produced from a Map.
`JSONArray`	`put(Object value)` Append an object value.
`Object`	`remove(int index)` Remove an index and close the hole.
`boolean`	`similar(Object other)` Determine if two JSONArrays are similar.
`JSONObject`	`toJSONObject(JSONArray names)` Produce a JSONObject by combining a JSONArray of names with the values of this JSONArray.
`String`	`toJSONString(int indentFactor)` Make a prettyprinted JSON text of this JSONArray.
`String`	`toString()` Make a JSON text of this JSONArray.
`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.getter.OptNullBasicTypeFromObjectGetter
getBigDecimal, getBigInteger, getBool, getByte, getChar, getDouble, getFloat, getInt, getLong, getShort, getStr

从类继承的方法 com.xiaoleilu.hutool.getter.OptNullBasicTypeGetter
getBigDecimal, getBigInteger, getBool, getByte, getChar, getDouble, getFloat, getInt, getLong, getObj, getShort, getStr

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

- 构造器详细资料
  - JSONArray
```
public JSONArray()
```
    Construct an empty JSONArray.
  - JSONArray
```
public JSONArray(JSONTokener x)
          throws JSONException
```
    Construct a JSONArray from a JSONTokener.
    
    参数:
    x - A JSONTokener
    
    抛出:
    
    JSONException - If there is a syntax error.
  - JSONArray
```
public JSONArray(String source)
          throws JSONException
```
    Construct a JSONArray from a source JSON text.
    
    参数:
    source - A string that begins with [ (left bracket) and ends with ] (right bracket).
    
    抛出:
    
    JSONException - If there is a syntax error.
  - JSONArray
```
public JSONArray(Object arrayOrCollection)
          throws JSONException
```
    Construct a JSONArray from an array or Collection
    
    抛出:
    
    JSONException - If not an array.
- 方法详细资料
  - iterator
```
public Iterator<Object> iterator()
```
    指定者:
    
    iterator 在接口中 Iterable<Object>
  - isNull
```
public boolean isNull(int index)
```
    Determine if the value is null.
    
    参数:
    index - The index must be between 0 and length() - 1.
    
    返回:
    true if the value at the index is null, or if there is no value.
  - join
```
public String join(String separator)
            throws JSONException
```
    Make a string from the contents of this JSONArray. The separator string is inserted between each element. Warning: This method assumes that the data structure is acyclical.
    
    参数:
    separator - A string that will be inserted between the elements.
    
    返回:
    a string.
    
    抛出:
    
    JSONException - If the array contains an invalid number.
  - length
```
public int length()
```
    Get the number of elements in the JSONArray, included nulls.
    
    返回:
    The length (or size).
  - get
```
public Object get(int index)
```
    Get the optional object value associated with an index.
    
    参数:
    index - The index must be between 0 and length() - 1.
    
    返回:
    An object value, or null if there is no object at that index.
  - getObj
```
public Object getObj(Integer index,
            Object defaultValue)
```
    从接口复制的说明: OptBasicTypeGetter
    
    获取Object属性值
    
    指定者:
    
    getObj 在接口中 OptBasicTypeGetter<Integer>
    
    指定者:
    
    getObj 在类中 OptNullBasicTypeFromObjectGetter<Integer>
    
    参数:
    index - 属性名
    defaultValue - 默认值
    
    返回:
    属性值，无对应值返回defaultValue
  - getEnum
```
public <E extends Enum<E>> E getEnum(Class<E> clazz,
                            int index)
```
    Get the enum value associated with a key.
    
    参数:
    clazz - The type of enum to retrieve.
    index - The index must be between 0 and length() - 1.
    
    返回:
    The enum value at the index location or null if not found
  - getEnum
```
public <E extends Enum<E>> E getEnum(Class<E> clazz,
                            int index,
                            E defaultValue)
```
    Get the enum value associated with a key.
    
    参数:
    clazz - The type of enum to retrieve.
    index - The index must be between 0 and length() - 1.
    defaultValue - The default in case the value is not found
    
    返回:
    The enum value at the index location or defaultValue if the value is not found or cannot be assigned to clazz
  - getJSONArray
```
public JSONArray getJSONArray(int index)
```
    Get the optional JSONArray associated with an index.
    
    参数:
    index - subscript
    
    返回:
    A JSONArray value, or null if the index has no value, or if the value is not a JSONArray.
  - getJSONObject
```
public JSONObject getJSONObject(int index)
```
    Get the optional JSONObject associated with an index. Null is returned if the key is not found, or null if the index has no value, or if the value is not a JSONObject.
    
    参数:
    index - The index must be between 0 and length() - 1.
    
    返回:
    A JSONObject value.
  - put
```
public JSONArray put(boolean value)
```
    Append a boolean value. This increases the array's length by one.
    
    参数:
    value - A boolean value.
    
    返回:
    this.
  - put
```
public JSONArray put(Collection<?> value)
```
    Put a value in the JSONArray, where the value will be a JSONArray which is produced from a Collection.
    
    参数:
    value - A Collection value.
    
    返回:
    this.
  - put
```
public JSONArray put(double value)
              throws JSONException
```
    Append a double value. This increases the array's length by one.
    
    参数:
    value - A double value.
    
    返回:
    this.
    
    抛出:
    
    JSONException - if the value is not finite.
  - put
```
public JSONArray put(int value)
```
    Append an int value. This increases the array's length by one.
    
    参数:
    value - An int value.
    
    返回:
    this.
  - put
```
public JSONArray put(long value)
```
    Append an long value. This increases the array's length by one.
    
    参数:
    value - A long value.
    
    返回:
    this.
  - put
```
public JSONArray put(Map<?,?> value)
```
    Put a value in the JSONArray, where the value will be a JSONObject which is produced from a Map.
    
    参数:
    value - A Map value.
    
    返回:
    this.
  - put
```
public JSONArray put(Object value)
```
    Append an object value. This increases the array's length by one.
    
    参数:
    value - An object value. The value should be a Boolean, Double, Integer, JSONArray, JSONObject, Long, or String, or the JSONNull.NULL object.
    
    返回:
    this.
  - put
```
public JSONArray put(int index,
            boolean value)
              throws JSONException
```
    Put or replace a boolean value in the JSONArray. If the index is greater than the length of the JSONArray, then null elements will be added as necessary to pad it out.
    
    参数:
    index - The subscript.
    value - A boolean value.
    
    返回:
    this.
    
    抛出:
    
    JSONException - If the index is negative.
  - put
```
public JSONArray put(int index,
            Collection<?> value)
              throws JSONException
```
    Put a value in the JSONArray, where the value will be a JSONArray which is produced from a Collection.
    
    参数:
    index - The subscript.
    value - A Collection value.
    
    返回:
    this.
    
    抛出:
    
    JSONException - If the index is negative or if the value is not finite.
  - put
```
public JSONArray put(int index,
            double value)
              throws JSONException
```
    Put or replace a double value. If the index is greater than the length of the JSONArray, then null elements will be added as necessary to pad it out.
    
    参数:
    index - The subscript.
    value - A double value.
    
    返回:
    this.
    
    抛出:
    
    JSONException - If the index is negative or if the value is not finite.
  - put
```
public JSONArray put(int index,
            int value)
              throws JSONException
```
    Put or replace an int value. If the index is greater than the length of the JSONArray, then null elements will be added as necessary to pad it out.
    
    参数:
    index - The subscript.
    value - An int value.
    
    返回:
    this.
    
    抛出:
    
    JSONException - If the index is negative.
  - put
```
public JSONArray put(int index,
            long value)
              throws JSONException
```
    Put or replace a long value. If the index is greater than the length of the JSONArray, then null elements will be added as necessary to pad it out.
    
    参数:
    index - The subscript.
    value - A long value.
    
    返回:
    this.
    
    抛出:
    
    JSONException - If the index is negative.
  - put
```
public JSONArray put(int index,
            Map<?,?> value)
              throws JSONException
```
    Put a value in the JSONArray, where the value will be a JSONObject that is produced from a Map.
    
    参数:
    index - The subscript.
    value - The Map value.
    
    返回:
    this.
    
    抛出:
    
    JSONException - If the index is negative or if the the value is an invalid number.
  - put
```
public JSONArray put(int index,
            Object value)
              throws JSONException
```
    Put or replace an object value in the JSONArray. If the index is greater than the length of the JSONArray, then null elements will be added as necessary to pad it out.
    
    参数:
    index - The subscript.
    value - The value to put into the array. The value should be a Boolean, Double, Integer, JSONArray, JSONObject, Long, or String, or the JSONNull.NULL object.
    
    返回:
    this.
    
    抛出:
    
    JSONException - If the index is negative or if the the value is an invalid number.
  - remove
```
public Object remove(int index)
```
    Remove an index and close the hole.
    
    参数:
    index - The index of the element to be removed.
    
    返回:
    The value that was associated with the index, or null if there was no value.
  - similar
```
public boolean similar(Object other)
```
    Determine if two JSONArrays are similar. They must contain similar sequences.
    
    参数:
    other - The other JSONArray
    
    返回:
    true if they are equal
  - toJSONObject
```
public JSONObject toJSONObject(JSONArray names)
                        throws JSONException
```
    Produce a JSONObject by combining a JSONArray of names with the values of this JSONArray.
    
    参数:
    names - A JSONArray containing a list of key strings. These will be paired with the values.
    
    返回:
    A JSONObject, or null if there are no names or if this JSONArray has no values.
    
    抛出:
    
    JSONException - If any of the names are null.
  - toString
```
public String toString()
```
    Make a JSON text of this JSONArray. For compactness, no unnecessary whitespace is added. If it is not possible to produce a syntactically correct JSON text then null will be returned instead. This could occur if the array contains an invalid number.
    Warning: This method assumes that the data structure is acyclical.
    
    覆盖:
    
    toString 在类中 Object
    
    返回:
    a printable, displayable, transmittable representation of the array.
  - toJSONString
```
public String toJSONString(int indentFactor)
                    throws JSONException
```
    Make a prettyprinted JSON text of this JSONArray. 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, transmittable representation of the object, beginning with [ (left bracket) and ending with ] (right bracket).
    
    抛出:
    
    JSONException
  - 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

类 JSONArray

构造器概要

方法概要

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

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

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

构造器详细资料

JSONArray

JSONArray

JSONArray

JSONArray

方法详细资料

iterator

isNull

join

length

get

getObj

getEnum

getEnum

getJSONArray

getJSONObject

put

put

put

put

put

put

put

put

put

put

put

put

put

put

remove

similar

toJSONObject

toString

toJSONString

write

write