Package com.unboundid.util.json

Class JSONArray

java.lang.Object
com.unboundid.util.json.JSONValue
com.unboundid.util.json.JSONArray
All Implemented Interfaces:
Serializable, Comparable<JSONValue>
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class JSONArray extends JSONValue
This class provides an implementation of a JSON value that represents an ordered collection of zero or more values. An array can contain elements of any type, including a mix of types, and including nested arrays. The same value may appear multiple times in an array.

The string representation of a JSON array is an open square bracket (U+005B) followed by a comma-delimited list of the string representations of the values in that array and a closing square bracket (U+005D). There must not be a comma between the last item in the array and the closing square bracket. There may optionally be any amount of whitespace (where whitespace characters include the ASCII space, horizontal tab, line feed, and carriage return characters) after the open square bracket, on either or both sides of commas separating values, and before the close square bracket.

The string representation returned by the toString() method (or appended to the buffer provided to the toString(StringBuilder) method) will include one space before each value in the array and one space before the closing square bracket. There will not be any space between a value and the comma that follows it. The string representation of each value in the array will be obtained using that value's toString method.

The normalized string representation will not include any optional spaces, and the normalized string representation of each value in the array will be obtained using that value's toNormalizedString method.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final JSONArray
    EMPTY_ARRAY
    A pre-allocated empty JSON array.

  • Constructor Summary

    Constructors
    Constructor
    Description
    JSONArray(JSONValue... values)
    Creates a new JSON array with the provided values.
    JSONArray(List<? extends JSONValue> values)
    Creates a new JSON array with the provided values.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    appendToJSONBuffer(JSONBuffer buffer)
    Appends this value to the provided JSON buffer.
    void
    appendToJSONBuffer(String fieldName, JSONBuffer buffer)
    Appends a field with the given name and this value to the provided JSON buffer.
    boolean
    contains(JSONValue value, boolean ignoreFieldNameCase, boolean ignoreValueCase, boolean ignoreArrayOrder, boolean recursive)
    Indicates whether this JSON array contains an element with the specified value.
    boolean
    equals(JSONArray array, boolean ignoreFieldNameCase, boolean ignoreValueCase, boolean ignoreArrayOrder)
    Indicates whether this JSON array is considered equivalent to the provided array, subject to the specified constraints.
    boolean
    equals(JSONValue v, boolean ignoreFieldNameCase, boolean ignoreValueCase, boolean ignoreArrayOrder)
    Indicates whether this JSON value is considered equal to the provided JSON value, subject to the specified constraints.
    boolean
    equals(Object o)
    Indicates whether the provided object is equal to this JSON value.
    List<JSONValue>
    getValues()
    Retrieves the set of values contained in this JSON array.
    int
    hashCode()
    Retrieves a hash code for this JSON value.
    boolean
    isEmpty()
    Indicates whether this array is empty.
    int
    size()
    Retrieves the number of values contained in this array.
    String
    toNormalizedString()
    Retrieves a normalized string representation of this array.
    String
    toNormalizedString(boolean ignoreFieldNameCase, boolean ignoreValueCase, boolean ignoreArrayOrder)
    Retrieves a normalized string representation of this array.
    void
    toNormalizedString(StringBuilder buffer)
    Appends a normalized string representation of this array to the provided buffer.
    void
    toNormalizedString(StringBuilder buffer, boolean ignoreFieldNameCase, boolean ignoreValueCase, boolean ignoreArrayOrder)
    Appends a normalized string representation of this array to the provided buffer.
    JSONArray
    toNormalizedValue(boolean ignoreFieldNameCase, boolean ignoreValueCase, boolean ignoreArrayOrder)
    Retrieves a normalized representation of this value using the provided settings.
    String
    toSingleLineString()
    Retrieves a single-line string representation of this array as it should appear in a JSON object, including the surrounding square brackets.
    void
    toSingleLineString(StringBuilder buffer)
    Appends a single-line string representation of this array as it should appear in a JSON object, including the surrounding square brackets, to the provided buffer.
    String
    toString()
    Retrieves a string representation of this array as it should appear in a JSON object, including the surrounding square brackets.
    void
    toString(StringBuilder buffer)
    Appends a string representation of this value as it should appear in a JSON object, including the surrounding square brackets,.

    Methods inherited from class com.unboundid.util.json.JSONValue

    compareTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • JSONArray

      public JSONArray(@Nullable JSONValue... values)
      Creates a new JSON array with the provided values.
      Parameters:
      values - The set of values to include in this JSON array. It may be null or empty to indicate that the array should be empty.

    • JSONArray

      public JSONArray(@Nullable List<? extends JSONValue> values)
      Creates a new JSON array with the provided values.
      Parameters:
      values - The set of values to include in this JSON array. It may be null or empty to indicate that the array should be empty.

  • Method Details

    • getValues

      @NotNull public List<JSONValue> getValues()
      Retrieves the set of values contained in this JSON array.
      Returns:
      The set of values contained in this JSON array.

    • isEmpty

      public boolean isEmpty()
      Indicates whether this array is empty.
      Returns:
      true if this array does not contain any values, or false if this array contains at least one value.

    • size

      public int size()
      Retrieves the number of values contained in this array.
      Returns:
      The number of values contained in this array.

    • hashCode

      public int hashCode()
      Retrieves a hash code for this JSON value.
      Specified by:
      hashCode in class JSONValue
      Returns:
      The hash code for this JSON value.

    • equals

      public boolean equals(@Nullable Object o)
      Indicates whether the provided object is equal to this JSON value.
      Specified by:
      equals in class JSONValue
      Parameters:
      o - The object to compare against this JSON value.
      Returns:
      true if the provided object is considered equal to this JSON value, or false if not.

    • equals

      public boolean equals(@NotNull JSONArray array, boolean ignoreFieldNameCase, boolean ignoreValueCase, boolean ignoreArrayOrder)
      Indicates whether this JSON array is considered equivalent to the provided array, subject to the specified constraints.
      Parameters:
      array - The array for which to make the determination.
      ignoreFieldNameCase - Indicates whether to ignore differences in capitalization in field names for any JSON objects contained in the array.
      ignoreValueCase - Indicates whether to ignore differences in capitalization for array elements that are JSON strings, as well as for the string values of any JSON objects and arrays contained in the array.
      ignoreArrayOrder - Indicates whether to ignore differences in the order of elements contained in the array.
      Returns:
      true if this JSON array is considered equivalent to the provided array (subject to the specified constraints), or false if not.

    • equals

      public boolean equals(@NotNull JSONValue v, boolean ignoreFieldNameCase, boolean ignoreValueCase, boolean ignoreArrayOrder)
      Indicates whether this JSON value is considered equal to the provided JSON value, subject to the specified constraints. Note that not all constraints will apply to all data types.
      Specified by:
      equals in class JSONValue
      Parameters:
      v - The JSON value for which to make the determination. It must not be null.
      ignoreFieldNameCase - Indicates whether to ignore differences in the capitalization of JSON field names.
      ignoreValueCase - Indicates whether to ignore differences in the capitalization of JSON values that represent strings.
      ignoreArrayOrder - Indicates whether to ignore differences in the order of elements in JSON arrays.
      Returns:
      true if this JSON value is considered equal to the provided JSON value (subject to the specified constraints), or false if not.

    • contains

      public boolean contains(@NotNull JSONValue value, boolean ignoreFieldNameCase, boolean ignoreValueCase, boolean ignoreArrayOrder, boolean recursive)
      Indicates whether this JSON array contains an element with the specified value.
      Parameters:
      value - The value for which to make the determination.
      ignoreFieldNameCase - Indicates whether to ignore differences in capitalization in field names for any JSON objects contained in the array.
      ignoreValueCase - Indicates whether to ignore differences in capitalization for array elements that are JSON strings, as well as for the string values of any JSON objects and arrays contained in the array.
      ignoreArrayOrder - Indicates whether to ignore differences in the order of elements contained in arrays. This is only applicable if the provided value is itself an array or is a JSON object that contains values that are arrays.
      recursive - Indicates whether to recursively look into any arrays contained inside this array.
      Returns:
      true if this JSON array contains an element with the specified value, or false if not.

    • toString

      @NotNull public String toString()
      Retrieves a string representation of this array as it should appear in a JSON object, including the surrounding square brackets. Appropriate encoding will also be used for all elements in the array. If the object containing this array was decoded from a string, then this method will use the same string representation as in that original object. Otherwise, the string representation will be constructed.
      Specified by:
      toString in class JSONValue
      Returns:
      A string representation of this array as it should appear in a JSON object, including the surrounding square brackets.

    • toString

      public void toString(@NotNull StringBuilder buffer)
      Appends a string representation of this value as it should appear in a JSON object, including the surrounding square brackets,. to the provided buffer. Appropriate encoding will also be used for all elements in the array. If the object containing this array was decoded from a string, then this method will use the same string representation as in that original object. Otherwise, the string representation will be constructed.
      Specified by:
      toString in class JSONValue
      Parameters:
      buffer - The buffer to which the information should be appended.

    • toSingleLineString

      @NotNull public String toSingleLineString()
      Retrieves a single-line string representation of this array as it should appear in a JSON object, including the surrounding square brackets. Appropriate encoding will also be used for all elements in the array.
      Specified by:
      toSingleLineString in class JSONValue
      Returns:
      A string representation of this array as it should appear in a JSON object, including the surrounding square brackets.

    • toSingleLineString

      public void toSingleLineString(@NotNull StringBuilder buffer)
      Appends a single-line string representation of this array as it should appear in a JSON object, including the surrounding square brackets, to the provided buffer. Appropriate encoding will also be used for all elements in the array.
      Specified by:
      toSingleLineString in class JSONValue
      Parameters:
      buffer - The buffer to which the information should be appended.

    • toNormalizedString

      @NotNull public String toNormalizedString()
      Retrieves a normalized string representation of this array. The normalized representation will not contain any line breaks, will not include any spaces around the enclosing brackets or around commas used to separate the elements, and it will use the normalized representations of those elements. The order of elements in an array is considered significant, and will not be affected by the normalization process.
      Specified by:
      toNormalizedString in class JSONValue
      Returns:
      A normalized string representation of this array.

    • toNormalizedString

      public void toNormalizedString(@NotNull StringBuilder buffer)
      Appends a normalized string representation of this array to the provided buffer. The normalized representation will not contain any line breaks, will not include any spaces around the enclosing brackets or around commas used to separate the elements, and it will use the normalized representations of those elements. The order of elements in an array is considered significant, and will not be affected by the normalization process.
      Specified by:
      toNormalizedString in class JSONValue
      Parameters:
      buffer - The buffer to which the information should be appended.

    • toNormalizedString

      @NotNull public String toNormalizedString(boolean ignoreFieldNameCase, boolean ignoreValueCase, boolean ignoreArrayOrder)
      Retrieves a normalized string representation of this array. The normalized representation will not contain any line breaks, will not include any spaces around the enclosing brackets or around commas used to separate the elements, and it will use the normalized representations of those elements. The order of elements in an array is considered significant, and will not be affected by the normalization process.
      Specified by:
      toNormalizedString in class JSONValue
      Parameters:
      ignoreFieldNameCase - Indicates whether field names should be treated in a case-sensitive (if false) or case-insensitive (if true) manner.
      ignoreValueCase - Indicates whether string field values should be treated in a case-sensitive (if false) or case-insensitive (if true) manner.
      ignoreArrayOrder - Indicates whether the order of elements in an array should be considered significant (if false) or insignificant (if true).
      Returns:
      A normalized string representation of this array.

    • toNormalizedString

      public void toNormalizedString(@NotNull StringBuilder buffer, boolean ignoreFieldNameCase, boolean ignoreValueCase, boolean ignoreArrayOrder)
      Appends a normalized string representation of this array to the provided buffer. The normalized representation will not contain any line breaks, will not include any spaces around the enclosing brackets or around commas used to separate the elements, and it will use the normalized representations of those elements. The order of elements in an array is considered significant, and will not be affected by the normalization process.
      Specified by:
      toNormalizedString in class JSONValue
      Parameters:
      buffer - The buffer to which the information should be appended.
      ignoreFieldNameCase - Indicates whether field names should be treated in a case-sensitive (if false) or case-insensitive (if true) manner.
      ignoreValueCase - Indicates whether string field values should be treated in a case-sensitive (if false) or case-insensitive (if true) manner.
      ignoreArrayOrder - Indicates whether the order of elements in an array should be considered significant (if false) or insignificant (if true).

    • toNormalizedValue

      @NotNull public JSONArray toNormalizedValue(boolean ignoreFieldNameCase, boolean ignoreValueCase, boolean ignoreArrayOrder)
      Retrieves a normalized representation of this value using the provided settings.
      Specified by:
      toNormalizedValue in class JSONValue
      Parameters:
      ignoreFieldNameCase - Indicates whether field names should be treated in a case-sensitive (if false) or case-insensitive (if true) manner.
      ignoreValueCase - Indicates whether string field values should be treated in a case-sensitive (if false) or case-insensitive (if true) manner.
      ignoreArrayOrder - Indicates whether the order of elements in an array should be considered significant (if false) or insignificant (if true).
      Returns:
      A normalized representation of this value using the provided settings.

    • appendToJSONBuffer

      public void appendToJSONBuffer(@NotNull JSONBuffer buffer)
      Appends this value to the provided JSON buffer. This will not include a field name, so it should only be used for Boolean value elements in an array.
      Specified by:
      appendToJSONBuffer in class JSONValue
      Parameters:
      buffer - The JSON buffer to which this value should be appended.

    • appendToJSONBuffer

      public void appendToJSONBuffer(@NotNull String fieldName, @NotNull JSONBuffer buffer)
      Appends a field with the given name and this value to the provided JSON buffer.
      Specified by:
      appendToJSONBuffer in class JSONValue
      Parameters:
      fieldName - The name to use for the field.
      buffer - The JSON buffer to which this value should be appended.