Package com.alibaba.fastjson2

Class JSONArray

java.lang.Object
java.util.AbstractCollection<Object>
java.util.AbstractList<Object>
java.util.ArrayList<Object>
com.alibaba.fastjson2.JSONArray
All Implemented Interfaces:
Serializable, Cloneable, Iterable<Object>, Collection<Object>, List<Object>, RandomAccess, SequencedCollection<Object>
public class JSONArray extends ArrayList<Object>
See Also:

  • Constructor Details

    • JSONArray

      public JSONArray()
      default

    • JSONArray

      public JSONArray(int initialCapacity)
      Parameters:
      initialCapacity - the initial capacity of the JSONArray
      Throws:
      IllegalArgumentException - If the specified initial capacity is negative

    • JSONArray

      public JSONArray(Collection<?> collection)
      Parameters:
      collection - the collection whose elements are to be placed into this JSONArray
      Throws:
      NullPointerException - If the specified collection is null

    • JSONArray

      public JSONArray(Object... items)
      Parameters:
      items - the array whose elements are to be placed into this JSONArray
      Throws:
      NullPointerException - If the specified items is null

  • Method Details

    • set

      public Object set(int index, Object element)
      Replaces the element at the specified position with the specified element 
      
    JSONArray array = new JSONArray();
    array.add(-1); // [-1]
    array.add(2); // [-1,2]
    array.set(0, 1); // [1,2]
    array.set(4, 3); // [1,2,null,null,3]
    array.set(-1, -1); // [1,2,null,null,-1]
    array.set(-2, -2); // [1,2,null,-2,-1]
    array.set(-6, -6); // [-6,1,2,null,-2,-1]
      Specified by:
      set in interface List<Object>
      Overrides:
      set in class ArrayList<Object>
      Parameters:
      index - index of the element to replace
      element - element to be stored at the specified position
      Returns:
      the element previously at the specified position
      Since:
      2.0.3

    • getJSONArray

      public JSONArray getJSONArray(int index)
      Returns the JSONArray at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      Returns:
      JSONArray or null
      Throws:
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

    • getJSONObject

      public JSONObject getJSONObject(int index)
      Returns the JSONObject at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      Returns:
      JSONObject or null
      Throws:
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

    • getString

      public String getString(int index)
      Returns the String at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      Returns:
      String or null
      Throws:
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

    • getDouble

      public Double getDouble(int index)
      Returns the Double at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      Returns:
      Double or null
      Throws:
      NumberFormatException - If the value of get is String and it contains no parsable double
      JSONException - Unsupported type conversion to Double
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

    • getDoubleValue

      public double getDoubleValue(int index)
      Returns a double value at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      Returns:
      double
      Throws:
      NumberFormatException - If the value of get is String and it contains no parsable double
      JSONException - Unsupported type conversion to double value
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

    • getFloat

      public Float getFloat(int index)
      Returns the Float at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      Returns:
      Float or null
      Throws:
      NumberFormatException - If the value of get is String and it contains no parsable float
      JSONException - Unsupported type conversion to Float
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

    • getFloatValue

      public float getFloatValue(int index)
      Returns a float value at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      Returns:
      float
      Throws:
      NumberFormatException - If the value of get is String and it contains no parsable float
      JSONException - Unsupported type conversion to float value
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

    • getLong

      public Long getLong(int index)
      Returns the Long at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      Returns:
      Long or null
      Throws:
      NumberFormatException - If the value of get is String and it contains no parsable long
      JSONException - Unsupported type conversion to Long
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

    • getLongValue

      public long getLongValue(int index)
      Returns a long value at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      Returns:
      long
      Throws:
      NumberFormatException - If the value of get is String and it contains no parsable long
      JSONException - Unsupported type conversion to long value
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

    • getInteger

      public Integer getInteger(int index)
      Returns the Integer at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      Returns:
      Integer or null
      Throws:
      NumberFormatException - If the value of get is String and it contains no parsable int
      JSONException - Unsupported type conversion to Integer
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

    • getIntValue

      public int getIntValue(int index)
      Returns an int value at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      Returns:
      int
      Throws:
      NumberFormatException - If the value of get is String and it contains no parsable int
      JSONException - Unsupported type conversion to int value
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

    • getShort

      public Short getShort(int index)
      Returns the Short at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      Returns:
      Short or null
      Throws:
      NumberFormatException - If the value of get is String and it contains no parsable short
      JSONException - Unsupported type conversion to Short
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

    • getShortValue

      public short getShortValue(int index)
      Returns a short value at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      Returns:
      short
      Throws:
      NumberFormatException - If the value of get is String and it contains no parsable short
      JSONException - Unsupported type conversion to short value
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

    • getByte

      public Byte getByte(int index)
      Returns the Byte at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      Returns:
      Byte or null
      Throws:
      NumberFormatException - If the value of get is String and it contains no parsable byte
      JSONException - Unsupported type conversion to Byte
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

    • getByteValue

      public byte getByteValue(int index)
      Returns a byte value at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      Returns:
      byte
      Throws:
      NumberFormatException - If the value of get is String and it contains no parsable byte
      JSONException - Unsupported type conversion to byte value
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

    • getBoolean

      public Boolean getBoolean(int index)
      Returns the Boolean at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      Returns:
      Boolean or null
      Throws:
      JSONException - Unsupported type conversion to Boolean
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

    • getBooleanValue

      public boolean getBooleanValue(int index)
      Returns a boolean value at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      Returns:
      boolean
      Throws:
      JSONException - Unsupported type conversion to boolean value
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

    • getBigInteger

      public BigInteger getBigInteger(int index)
      Returns the BigInteger at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      Returns:
      BigInteger or null
      Throws:
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())
      JSONException - Unsupported type conversion to BigInteger
      NumberFormatException - If the value of get is String and it is not a valid representation of BigInteger

    • getBigDecimal

      public BigDecimal getBigDecimal(int index)
      Returns the BigDecimal at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      Returns:
      BigDecimal or null
      Throws:
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())
      JSONException - Unsupported type conversion to BigDecimal
      NumberFormatException - If the value of get is String and it is not a valid representation of BigDecimal

    • getDate

      public Date getDate(int index)
      Returns the Date at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      Returns:
      Date or null
      Throws:
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

    • getDate

      public Date getDate(int index, Date defaultValue)
      Returns the Date at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      defaultValue - default value to return if the element is null
      Returns:
      Date or defaultValue
      Throws:
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())
      Since:
      2.0.27

    • getInstant

      public Instant getInstant(int index)
      Returns the Instant at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      Returns:
      Instant or null
      Throws:
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

    • getLocalDate

      public LocalDate getLocalDate(int index)
      Returns the LocalDate at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      Returns:
      LocalDate or null
      Throws:
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())
      Since:
      2.0.57

    • getLocalDate

      public LocalDate getLocalDate(int index, LocalDate defaultValue)
      Returns the LocalDate at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      defaultValue - default value to return if the element is null
      Returns:
      LocalDate or defaultValue
      Throws:
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())
      Since:
      2.0.57

    • getLocalTime

      public LocalTime getLocalTime(int index)
      Returns the LocalTime at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      Returns:
      LocalTime or null
      Throws:
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())
      Since:
      2.0.57

    • getLocalTime

      public LocalTime getLocalTime(int index, LocalTime defaultValue)
      Returns the LocalTime at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      defaultValue - default value to return if the element is null
      Returns:
      LocalTime or defaultValue
      Throws:
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())
      Since:
      2.0.57

    • getOffsetTime

      public OffsetTime getOffsetTime(int index)
      Returns the OffsetTime at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      Returns:
      OffsetTime or null
      Throws:
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())
      Since:
      2.0.57

    • getOffsetTime

      public OffsetTime getOffsetTime(int index, OffsetTime defaultValue)
      Returns the OffsetTime at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      defaultValue - default value to return if the element is null
      Returns:
      OffsetTime or defaultValue
      Throws:
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())
      Since:
      2.0.57

    • getLocalDateTime

      public LocalDateTime getLocalDateTime(int index)
      Returns the LocalDateTime at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      Returns:
      LocalDateTime or null
      Throws:
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())
      Since:
      2.0.57

    • getLocalDateTime

      public LocalDateTime getLocalDateTime(int index, LocalDateTime defaultValue)
      Returns the LocalDateTime at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      defaultValue - default value to return if the element is null
      Returns:
      LocalDateTime or defaultValue
      Throws:
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())
      Since:
      2.0.57

    • getOffsetDateTime

      public OffsetDateTime getOffsetDateTime(int index)
      Returns the OffsetDateTime at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      Returns:
      OffsetDateTime or null
      Throws:
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())
      Since:
      2.0.57

    • getOffsetDateTime

      public OffsetDateTime getOffsetDateTime(int index, OffsetDateTime defaultValue)
      Returns the OffsetDateTime at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      defaultValue - default value to return if the element is null
      Returns:
      OffsetDateTime or defaultValue
      Throws:
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())
      Since:
      2.0.57

    • getZonedDateTime

      public ZonedDateTime getZonedDateTime(int index)
      Returns the ZonedDateTime at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      Returns:
      ZonedDateTime or null
      Throws:
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())
      Since:
      2.0.57

    • getZonedDateTime

      public ZonedDateTime getZonedDateTime(int index, ZonedDateTime defaultValue)
      Returns the ZonedDateTime at the specified location in this JSONArray.
      Parameters:
      index - index of the element to return
      defaultValue - default value to return if the element is null
      Returns:
      ZonedDateTime or defaultValue
      Throws:
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())
      Since:
      2.0.57

    • toString

      public String toString()
      Serialize to JSON String
      Overrides:
      toString in class AbstractCollection<Object>
      Returns:
      JSON String

    • toString

      public String toString(JSONWriter.Feature... features)
      Serialize to JSON String
      Parameters:
      features - features to be enabled in serialization
      Returns:
      JSON String

    • toJSONString

      public String toJSONString(JSONWriter.Feature... features)
      Serialize to JSON String
      Parameters:
      features - features to be enabled in serialization
      Returns:
      JSON String

    • toJSONString

      public static String toJSONString(Object object, JSONWriter.Feature... features)
      Serialize Java Object to JSON String with specified JSONReader.Features enabled
      Parameters:
      object - Java Object to be serialized into JSON String
      features - features to be enabled in serialization
      Since:
      2.0.15

    • toJSONBBytes

      public byte[] toJSONBBytes(JSONWriter.Feature... features)
      Serialize to JSONB bytes
      Parameters:
      features - features to be enabled in serialization
      Returns:
      JSONB bytes

    • to

      public <T> T to(Type type)
      Convert this JSONArray to the specified Object 
      
 JSONArray array = ...
 List<User> users = array.to(new TypeReference<ArrayList<User>>(){}.getType());
      Parameters:
      type - specify the Type to be converted
      Since:
      2.0.4

    • to

      public <T> T to(Type type, long features)
      Convert this JSONArray to the specified Object 
      
 JSONArray array = ...
 List<User> users = array.to(new TypeReference<ArrayList<User>>(){}.getType());
      Parameters:
      type - specify the Type to be converted
      Since:
      2.0.51

    • to

      public <T> T to(Class<T> type)
      Since:
      2.0.9

    • toJavaObject

      @Deprecated public <T> T toJavaObject(Type type)
      Deprecated.
      since 2.0.4, please use to(Type)
      Convert this JSONArray to the specified Object
      Parameters:
      type - specify the Type to be converted

    • toList

      public <T> List<T> toList(Class<T> itemClass, JSONReader.Feature... features)
      Convert all the members of this JSONArray into the specified Object. 
      
 String json = "[{\"id\": 1, \"name\": \"fastjson\"}, {\"id\": 2, \"name\": \"fastjson2\"}]";
 JSONArray array = JSON.parseArray(json);
 List<User> users = array.toList(User.class);
      Parameters:
      itemClass - specify the Class<T> to be converted
      features - features to be enabled in parsing
      Since:
      2.0.4

    • toArray

      public <T> T[] toArray(Class<T> itemClass, JSONReader.Feature... features)
      Convert all the members of this JSONArray into the specified Object. 
      
 String json = "[{\"id\": 1, \"name\": \"fastjson\"}, {\"id\": 2, \"name\": \"fastjson2\"}]";
 JSONArray array = JSON.parseArray(json);
 List<User> users = array.toList(User.class);
      Parameters:
      itemClass - specify the Class<T> to be converted
      features - features to be enabled in parsing
      Since:
      2.0.4

    • toJavaList

      public <T> List<T> toJavaList(Class<T> clazz, JSONReader.Feature... features)
      Convert all the members of this JSONArray into the specified Object.
      Parameters:
      clazz - specify the Class<T> to be converted
      features - features to be enabled in parsing please use toList(Class, JSONReader.Feature...)

    • getObject

      public <T> T getObject(int index, Type type, JSONReader.Feature... features)
      Returns the result of the Type converter conversion of the element at the specified position in this JSONArray. 
      
 JSONArray array = ...
 User user = array.getObject(0, TypeReference<HashMap<String ,User>>(){}.getType());
      Parameters:
      index - index of the element to return
      type - specify the Type to be converted
      Returns:
      <T> or null
      Throws:
      JSONException - If no suitable conversion method is found
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

    • getObject

      public <T> T getObject(int index, Class<T> type, JSONReader.Feature... features)
      Returns the result of the Type converter conversion of the element at the specified position in this JSONArray.

      User user = jsonArray.getObject(0, User.class);

      Parameters:
      index - index of the element to return
      type - specify the Class to be converted
      Returns:
      <T> or null
      Throws:
      JSONException - If no suitable conversion method is found
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

    • getObject

      public <T> T getObject(int index, Function<JSONObject,T> creator)
      Since:
      2.0.3

    • addObject

      public JSONObject addObject()
      Adds a new JSONObject to the end of this JSONArray.
      Returns:
      the newly created JSONObject
      Since:
      2.0.3

    • addArray

      public JSONArray addArray()
      Adds a new JSONArray to the end of this JSONArray.
      Returns:
      the newly created JSONArray
      Since:
      2.0.3

    • fluentAdd

      public JSONArray fluentAdd(Object element)
      Chained addition of elements 
       JSONArray array = new JSONArray().fluentAdd(1).fluentAdd(2).fluentAdd(3);
      Parameters:
      element - element to be appended to this list
      Returns:
      this JSONArray instance
      Since:
      2.0.3

    • fluentClear

      public JSONArray fluentClear()
      Chained clear operation that removes all elements from this JSONArray.
      Returns:
      this JSONArray instance
      Since:
      2.0.3

    • fluentRemove

      public JSONArray fluentRemove(int index)
      Chained remove operation that removes the element at the specified position.
      Parameters:
      index - the index of the element to be removed
      Returns:
      this JSONArray instance
      Since:
      2.0.3

    • fluentSet

      public JSONArray fluentSet(int index, Object element)
      Chained set operation that replaces the element at the specified position.
      Parameters:
      index - index of the element to replace
      element - element to be stored at the specified position
      Returns:
      this JSONArray instance
      Since:
      2.0.3

    • fluentRemove

      public JSONArray fluentRemove(Object o)
      Chained remove operation that removes the first occurrence of the specified element.
      Parameters:
      o - element to be removed from this list, if present
      Returns:
      this JSONArray instance
      Since:
      2.0.3

    • fluentRemoveAll

      public JSONArray fluentRemoveAll(Collection<?> c)
      Chained remove operation that removes from this list all of its elements that are contained in the specified collection.
      Parameters:
      c - collection containing elements to be removed from this list
      Returns:
      this JSONArray instance
      Since:
      2.0.3

    • fluentAddAll

      public JSONArray fluentAddAll(Collection<?> c)
      Chained add operation that appends all of the elements in the specified collection to the end of this list.
      Parameters:
      c - collection containing elements to be added to this list
      Returns:
      this JSONArray instance
      Since:
      2.0.3

    • isValid

      public boolean isValid(JSONSchema schema)
      Checks if this JSONArray is valid against the specified JSONSchema.
      Parameters:
      schema - the JSONSchema to validate against
      Returns:
      true if this JSONArray is valid against the schema, false otherwise
      Since:
      2.0.3

    • clone

      public Object clone()
      Creates and returns a copy of this JSONArray.
      Overrides:
      clone in class ArrayList<Object>
      Returns:
      a clone of this instance

    • of

      public static JSONArray of(Object... items)
      Pack multiple elements as JSONArray 
       JSONArray array = JSONArray.of(1, 2, "3", 4F, 5L, 6D, true);
      Parameters:
      items - element set

    • of

      public static JSONArray of(Object item)
      Pack an element as JSONArray 
       JSONArray array = JSONArray.of("fastjson");
      Parameters:
      item - target element

    • copyOf

      public static JSONArray copyOf(Collection collection)
      Returns an JSONArray containing the elements of the given Collection, in its iteration order. 
       JSONArray array = JSONArray.copyOf(List.of("fastjson"));
      Since:
      2.0.22

    • of

      public static JSONArray of(Object first, Object second)
      Pack two elements as JSONArray 
       JSONArray array = JSONArray.of("fastjson", 2);
      Parameters:
      first - first element
      second - second element

    • of

      public static JSONArray of(Object first, Object second, Object third)
      Pack three elements as JSONArray 
       JSONArray array = JSONArray.of("fastjson", 2, true);
      Parameters:
      first - first element
      second - second element
      third - third element

    • parseArray

      public static JSONArray parseArray(String text, JSONReader.Feature... features)
      Parse JSON String into JSONArray
      Parameters:
      text - the JSON String to be parsed
      features - features to be enabled in parsing

    • parseArray

      public static <T> List<T> parseArray(String text, Class<T> type, JSONReader.Feature... features)
      Parse JSON String into List
      Parameters:
      text - the JSON String to be parsed
      type - specify the Class to be converted
      features - features to be enabled in parsing

    • parse

      public static JSONArray parse(String text, JSONReader.Feature... features)
      Parse JSON String into JSONArray
      Parameters:
      text - the JSON String to be parsed
      features - features to be enabled in parsing
      Since:
      2.0.13

    • parseArray

      public static <T> List<T> parseArray(String input, Class<T> type)
      Parse JSON String into List
      Parameters:
      input - the JSON String to be parsed
      type - specify the Class to be converted
      Since:
      2.0.24

    • from

      public static JSONArray from(Object obj)
      See JSON.toJSON(java.lang.Object) for details

    • from

      public static JSONArray from(Object obj, JSONWriter.Feature... writeFeatures)
      See JSON.toJSON(java.lang.Object) for details