PlotSquared/src/main/java/com/intellectualcrafters/json/JSONArray.java

882 lines
31 KiB
Java
Raw Normal View History

2014-11-08 20:27:09 +01:00
////////////////////////////////////////////////////////////////////////////////////////////////////
// PlotSquared - A plot manager and world generator for the Bukkit API /
// Copyright (c) 2014 IntellectualSites/IntellectualCrafters /
// /
// This program is free software; you can redistribute it and/or modify /
// it under the terms of the GNU General Public License as published by /
// the Free Software Foundation; either version 3 of the License, or /
// (at your option) any later version. /
// /
// This program is distributed in the hope that it will be useful, /
// but WITHOUT ANY WARRANTY; without even the implied warranty of /
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the /
// GNU General Public License for more details. /
// /
// You should have received a copy of the GNU General Public License /
// along with this program; if not, write to the Free Software Foundation, /
// Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA /
// /
// You can contact us via: support@intellectualsites.com /
////////////////////////////////////////////////////////////////////////////////////////////////////
package com.intellectualcrafters.json;
import java.io.IOException;
import java.io.StringWriter;
import java.io.Writer;
import java.lang.reflect.Array;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Map;
/**
2014-12-18 03:15:11 +01:00
* 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 <code>get</code> and <code>opt</code> methods for
* accessing the values by index, and <code>put</code> methods for adding or replacing values. The values can be any of
* these types: <code>Boolean</code>, <code>JSONArray</code>, <code>JSONObject</code>, <code>Number</code>,
* <code>String</code>, or the <code>JSONObject.NULL object</code>.
2015-03-13 08:05:06 +01:00
*
2014-12-18 03:15:11 +01:00
* The constructor can convert a JSON text into a Java object. The <code>toString</code> method converts to JSON text.
2015-03-13 08:05:06 +01:00
*
2014-12-18 03:15:11 +01:00
* A <code>get</code> method returns a value if one can be found, and throws an exception if one cannot be found. An
* <code>opt</code> method returns a default value instead of throwing an exception, and so is useful for obtaining
* optional values.
2015-03-13 08:05:06 +01:00
*
2014-12-18 03:15:11 +01:00
* The generic <code>get()</code> and <code>opt()</code> methods return an object which you can cast or query for type.
* There are also typed <code>get</code> and <code>opt</code> methods that do type checking and type coercion for you.
2015-03-13 08:05:06 +01:00
*
2014-12-18 03:15:11 +01:00
* The texts produced by the <code>toString</code> methods strictly conform to JSON syntax rules. The constructors are
* more forgiving in the texts they will accept: <ul> <li>An extra <code>,</code>&nbsp;<small>(comma)</small> may appear
* just before the closing bracket.</li> <li>The <code>null</code> value will be inserted when there is <code>,</code>
* &nbsp;<small>(comma)</small> elision.</li> <li>Strings may be quoted with <code>'</code>&nbsp;<small>(single
* quote)</small>.</li> <li>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: <code>{ }
* [ ] / \ : , #</code> and if they do not look like numbers and if they are not the reserved words <code>true</code>,
* <code>false</code>, or <code>null</code>.</li> </ul>
*
* @author JSON.org
* @version 2014-05-03
*/
public class JSONArray {
/**
* The arrayList where the JSONArray's properties are kept.
*/
private final ArrayList<Object> myArrayList;
2015-02-23 02:32:27 +01:00
/**
* Construct an empty JSONArray.
*/
public JSONArray() {
this.myArrayList = new ArrayList<Object>();
}
2015-02-23 02:32:27 +01:00
/**
* Construct a JSONArray from a JSONTokener.
*
2014-12-18 03:15:11 +01:00
* @param x A JSONTokener
*
* @throws JSONException If there is a syntax error.
*/
2014-11-05 04:42:08 +01:00
public JSONArray(final JSONTokener x) throws JSONException {
this();
if (x.nextClean() != '[') {
throw x.syntaxError("A JSONArray text must start with '['");
}
if (x.nextClean() != ']') {
x.back();
2015-02-20 07:34:19 +01:00
for (;;) {
if (x.nextClean() == ',') {
x.back();
this.myArrayList.add(JSONObject.NULL);
2014-12-18 03:15:11 +01:00
} else {
x.back();
this.myArrayList.add(x.nextValue());
}
switch (x.nextClean()) {
2014-11-05 04:42:08 +01:00
case ',':
if (x.nextClean() == ']') {
return;
}
x.back();
break;
case ']':
return;
2014-11-05 04:42:08 +01:00
default:
throw x.syntaxError("Expected a ',' or ']'");
}
}
}
}
2015-02-23 02:32:27 +01:00
/**
* Construct a JSONArray from a source JSON text.
*
2014-12-18 03:15:11 +01:00
* @param source A string that begins with <code>[</code>&nbsp;<small>(left bracket)</small> and ends with
* <code>]</code> &nbsp;<small>(right bracket)</small>.
*
* @throws JSONException If there is a syntax error.
*/
2014-11-05 04:42:08 +01:00
public JSONArray(final String source) throws JSONException {
this(new JSONTokener(source));
}
2015-02-23 02:32:27 +01:00
/**
* Construct a JSONArray from a Collection.
*
2014-12-18 03:15:11 +01:00
* @param collection A Collection.
*/
2014-11-05 04:42:08 +01:00
public JSONArray(final Collection<Object> collection) {
this.myArrayList = new ArrayList<Object>();
if (collection != null) {
2014-12-16 06:03:20 +01:00
for (final Object aCollection : collection) {
2014-11-21 23:45:46 +01:00
this.myArrayList.add(JSONObject.wrap(aCollection));
}
}
}
2015-02-23 02:32:27 +01:00
/**
* Construct a JSONArray from an array
*
2014-12-18 03:15:11 +01:00
* @throws JSONException If not an array.
*/
2014-11-05 04:42:08 +01:00
public JSONArray(final Object array) throws JSONException {
this();
if (array.getClass().isArray()) {
2014-11-05 04:42:08 +01:00
final int length = Array.getLength(array);
for (int i = 0; i < length; i += 1) {
this.put(JSONObject.wrap(Array.get(array, i)));
}
2014-12-18 03:15:11 +01:00
} else {
2014-11-05 04:42:08 +01:00
throw new JSONException("JSONArray initial value should be a string or collection or array.");
}
}
2015-02-23 02:32:27 +01:00
/**
* Get the object value associated with an index.
*
2014-12-18 03:15:11 +01:00
* @param index The index must be between 0 and length() - 1.
*
* @return An object value.
2014-12-18 03:15:11 +01:00
*
* @throws JSONException If there is no value for the index.
*/
2014-11-05 04:42:08 +01:00
public Object get(final int index) throws JSONException {
final Object object = this.opt(index);
if (object == null) {
throw new JSONException("JSONArray[" + index + "] not found.");
}
return object;
}
2015-02-23 02:32:27 +01:00
/**
2014-12-18 03:15:11 +01:00
* Get the boolean value associated with an index. The string values "true" and "false" are converted to boolean.
*
* @param index The index must be between 0 and length() - 1.
*
* @return The truth.
2014-12-18 03:15:11 +01:00
*
* @throws JSONException If there is no value for the index or if the value is not convertible to boolean.
*/
2014-11-05 04:42:08 +01:00
public boolean getBoolean(final int index) throws JSONException {
final Object object = this.get(index);
if (object.equals(Boolean.FALSE) || ((object instanceof String) && ((String) object).equalsIgnoreCase("false"))) {
return false;
2014-12-18 03:15:11 +01:00
} else if (object.equals(Boolean.TRUE) || ((object instanceof String) && ((String) object).equalsIgnoreCase("true"))) {
return true;
}
throw new JSONException("JSONArray[" + index + "] is not a boolean.");
}
2015-02-23 02:32:27 +01:00
/**
* Get the double value associated with an index.
*
2014-12-18 03:15:11 +01:00
* @param index The index must be between 0 and length() - 1.
*
* @return The value.
2014-12-18 03:15:11 +01:00
*
* @throws JSONException If the key is not found or if the value cannot be converted to a number.
*/
2014-11-05 04:42:08 +01:00
public double getDouble(final int index) throws JSONException {
final Object object = this.get(index);
try {
2014-11-05 04:42:08 +01:00
return object instanceof Number ? ((Number) object).doubleValue() : Double.parseDouble((String) object);
2014-12-18 03:15:11 +01:00
} catch (final Exception e) {
throw new JSONException("JSONArray[" + index + "] is not a number.");
}
}
2015-02-23 02:32:27 +01:00
/**
* Get the int value associated with an index.
*
2014-12-18 03:15:11 +01:00
* @param index The index must be between 0 and length() - 1.
*
* @return The value.
2014-12-18 03:15:11 +01:00
*
* @throws JSONException If the key is not found or if the value is not a number.
*/
2014-11-05 04:42:08 +01:00
public int getInt(final int index) throws JSONException {
final Object object = this.get(index);
try {
2014-11-05 04:42:08 +01:00
return object instanceof Number ? ((Number) object).intValue() : Integer.parseInt((String) object);
2014-12-18 03:15:11 +01:00
} catch (final Exception e) {
throw new JSONException("JSONArray[" + index + "] is not a number.");
}
}
2015-02-23 02:32:27 +01:00
/**
* Get the JSONArray associated with an index.
*
2014-12-18 03:15:11 +01:00
* @param index The index must be between 0 and length() - 1.
*
* @return A JSONArray value.
2014-12-18 03:15:11 +01:00
*
* @throws JSONException If there is no value for the index. or if the value is not a JSONArray
*/
2014-11-05 04:42:08 +01:00
public JSONArray getJSONArray(final int index) throws JSONException {
final Object object = this.get(index);
if (object instanceof JSONArray) {
return (JSONArray) object;
}
throw new JSONException("JSONArray[" + index + "] is not a JSONArray.");
}
2015-02-23 02:32:27 +01:00
/**
* Get the JSONObject associated with an index.
*
2014-12-18 03:15:11 +01:00
* @param index subscript
*
* @return A JSONObject value.
2014-12-18 03:15:11 +01:00
*
* @throws JSONException If there is no value for the index or if the value is not a JSONObject
*/
2014-11-05 04:42:08 +01:00
public JSONObject getJSONObject(final int index) throws JSONException {
final Object object = this.get(index);
if (object instanceof JSONObject) {
return (JSONObject) object;
}
throw new JSONException("JSONArray[" + index + "] is not a JSONObject.");
}
2015-02-23 02:32:27 +01:00
/**
* Get the long value associated with an index.
*
2014-12-18 03:15:11 +01:00
* @param index The index must be between 0 and length() - 1.
*
* @return The value.
2014-12-18 03:15:11 +01:00
*
* @throws JSONException If the key is not found or if the value cannot be converted to a number.
*/
2014-11-05 04:42:08 +01:00
public long getLong(final int index) throws JSONException {
final Object object = this.get(index);
try {
2014-11-05 04:42:08 +01:00
return object instanceof Number ? ((Number) object).longValue() : Long.parseLong((String) object);
2014-12-18 03:15:11 +01:00
} catch (final Exception e) {
throw new JSONException("JSONArray[" + index + "] is not a number.");
}
}
2015-02-23 02:32:27 +01:00
/**
* Get the string associated with an index.
*
2014-12-18 03:15:11 +01:00
* @param index The index must be between 0 and length() - 1.
*
* @return A string value.
2014-12-18 03:15:11 +01:00
*
* @throws JSONException If there is no string value for the index.
*/
2014-11-05 04:42:08 +01:00
public String getString(final int index) throws JSONException {
final Object object = this.get(index);
if (object instanceof String) {
return (String) object;
}
throw new JSONException("JSONArray[" + index + "] not a string.");
}
2015-02-23 02:32:27 +01:00
/**
* Determine if the value is null.
*
2014-12-18 03:15:11 +01:00
* @param index The index must be between 0 and length() - 1.
*
* @return true if the value at the index is null, or if there is no value.
*/
2014-11-05 04:42:08 +01:00
public boolean isNull(final int index) {
return JSONObject.NULL.equals(this.opt(index));
}
2015-02-23 02:32:27 +01:00
/**
2014-12-18 03:15:11 +01:00
* Make a string from the contents of this JSONArray. The <code>separator</code> string is inserted between each
* element. Warning: This method assumes that the data structure is acyclical.
*
* @param separator A string that will be inserted between the elements.
*
* @return a string.
2014-12-18 03:15:11 +01:00
*
* @throws JSONException If the array contains an invalid number.
*/
2014-11-05 04:42:08 +01:00
public String join(final String separator) throws JSONException {
final int len = this.length();
final StringBuilder sb = new StringBuilder();
for (int i = 0; i < len; i += 1) {
if (i > 0) {
sb.append(separator);
}
sb.append(JSONObject.valueToString(this.myArrayList.get(i)));
}
return sb.toString();
}
2015-02-23 02:32:27 +01:00
/**
* Get the number of elements in the JSONArray, included nulls.
*
* @return The length (or size).
*/
public int length() {
return this.myArrayList.size();
}
2015-02-23 02:32:27 +01:00
/**
* Get the optional object value associated with an index.
*
2014-12-18 03:15:11 +01:00
* @param index The index must be between 0 and length() - 1.
*
* @return An object value, or null if there is no object at that index.
*/
2014-11-05 04:42:08 +01:00
public Object opt(final int index) {
return ((index < 0) || (index >= this.length())) ? null : this.myArrayList.get(index);
}
2015-02-23 02:32:27 +01:00
/**
2014-12-18 03:15:11 +01:00
* Get the optional boolean value associated with an index. It returns false if there is no value at that index, or
* if the value is not Boolean.TRUE or the String "true".
*
* @param index The index must be between 0 and length() - 1.
*
* @return The truth.
*/
2014-11-05 04:42:08 +01:00
public boolean optBoolean(final int index) {
return this.optBoolean(index, false);
}
2015-02-23 02:32:27 +01:00
/**
2014-12-18 03:15:11 +01:00
* Get the optional boolean value associated with an index. It returns the defaultValue if there is no value at that
* index or if it is not a Boolean or the String "true" or "false" (case insensitive).
*
* @param index The index must be between 0 and length() - 1.
* @param defaultValue A boolean default.
*
* @return The truth.
*/
2014-11-05 04:42:08 +01:00
public boolean optBoolean(final int index, final boolean defaultValue) {
try {
return this.getBoolean(index);
2014-12-18 03:15:11 +01:00
} catch (final Exception e) {
return defaultValue;
}
}
2015-02-23 02:32:27 +01:00
/**
2014-12-18 03:15:11 +01:00
* Get the optional double value associated with an index. NaN is returned if there is no value for the index, or if
* the value is not a number and cannot be converted to a number.
*
* @param index The index must be between 0 and length() - 1.
*
* @return The value.
*/
2014-11-05 04:42:08 +01:00
public double optDouble(final int index) {
return this.optDouble(index, Double.NaN);
}
2015-02-23 02:32:27 +01:00
/**
2014-12-18 03:15:11 +01:00
* Get the optional double value associated with an index. The defaultValue is returned if there is no value for the
* index, or if the value is not a number and cannot be converted to a number.
*
* @param index subscript
* @param defaultValue The default value.
*
* @return The value.
*/
2014-11-05 04:42:08 +01:00
public double optDouble(final int index, final double defaultValue) {
try {
return this.getDouble(index);
2014-12-18 03:15:11 +01:00
} catch (final Exception e) {
return defaultValue;
}
}
2015-02-23 02:32:27 +01:00
/**
2014-12-18 03:15:11 +01:00
* Get the optional int value associated with an index. Zero is returned if there is no value for the index, or if
* the value is not a number and cannot be converted to a number.
*
* @param index The index must be between 0 and length() - 1.
*
* @return The value.
*/
2014-11-05 04:42:08 +01:00
public int optInt(final int index) {
return this.optInt(index, 0);
}
2015-02-23 02:32:27 +01:00
/**
2014-12-18 03:15:11 +01:00
* Get the optional int value associated with an index. The defaultValue is returned if there is no value for the
* index, or if the value is not a number and cannot be converted to a number.
*
* @param index The index must be between 0 and length() - 1.
* @param defaultValue The default value.
*
* @return The value.
*/
2014-11-05 04:42:08 +01:00
public int optInt(final int index, final int defaultValue) {
try {
return this.getInt(index);
2014-12-18 03:15:11 +01:00
} catch (final Exception e) {
return defaultValue;
}
}
2015-02-23 02:32:27 +01:00
/**
* Get the optional JSONArray associated with an index.
*
2014-12-18 03:15:11 +01:00
* @param index subscript
*
* @return A JSONArray value, or null if the index has no value, or if the value is not a JSONArray.
*/
2014-11-05 04:42:08 +01:00
public JSONArray optJSONArray(final int index) {
final Object o = this.opt(index);
return o instanceof JSONArray ? (JSONArray) o : null;
}
2015-02-23 02:32:27 +01:00
/**
2014-12-18 03:15:11 +01:00
* 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.
*
* @param index The index must be between 0 and length() - 1.
*
* @return A JSONObject value.
*/
2014-11-05 04:42:08 +01:00
public JSONObject optJSONObject(final int index) {
final Object o = this.opt(index);
return o instanceof JSONObject ? (JSONObject) o : null;
}
2015-02-23 02:32:27 +01:00
/**
2014-12-18 03:15:11 +01:00
* Get the optional long value associated with an index. Zero is returned if there is no value for the index, or if
* the value is not a number and cannot be converted to a number.
*
* @param index The index must be between 0 and length() - 1.
*
* @return The value.
*/
2014-11-05 04:42:08 +01:00
public long optLong(final int index) {
return this.optLong(index, 0);
}
2015-02-23 02:32:27 +01:00
/**
2014-12-18 03:15:11 +01:00
* Get the optional long value associated with an index. The defaultValue is returned if there is no value for the
* index, or if the value is not a number and cannot be converted to a number.
*
* @param index The index must be between 0 and length() - 1.
* @param defaultValue The default value.
*
* @return The value.
*/
2014-11-05 04:42:08 +01:00
public long optLong(final int index, final long defaultValue) {
try {
return this.getLong(index);
2014-12-18 03:15:11 +01:00
} catch (final Exception e) {
return defaultValue;
}
}
2015-02-23 02:32:27 +01:00
/**
2014-12-18 03:15:11 +01:00
* Get the optional string value associated with an index. It returns an empty string if there is no value at that
* index. If the value is not a string and is not null, then it is coverted to a string.
*
* @param index The index must be between 0 and length() - 1.
*
* @return A String value.
*/
2014-11-05 04:42:08 +01:00
public String optString(final int index) {
return this.optString(index, "");
}
2015-02-23 02:32:27 +01:00
/**
2014-12-18 03:15:11 +01:00
* Get the optional string associated with an index. The defaultValue is returned if the key is not found.
*
* @param index The index must be between 0 and length() - 1.
* @param defaultValue The default value.
*
* @return A String value.
*/
2014-11-05 04:42:08 +01:00
public String optString(final int index, final String defaultValue) {
final Object object = this.opt(index);
return JSONObject.NULL.equals(object) ? defaultValue : object.toString();
}
2015-02-23 02:32:27 +01:00
/**
* Append a boolean value. This increases the array's length by one.
*
2014-12-18 03:15:11 +01:00
* @param value A boolean value.
*
* @return this.
*/
2014-11-05 04:42:08 +01:00
public JSONArray put(final boolean value) {
this.put(value ? Boolean.TRUE : Boolean.FALSE);
return this;
}
2015-02-23 02:32:27 +01:00
/**
2014-12-18 03:15:11 +01:00
* Put a value in the JSONArray, where the value will be a JSONArray which is produced from a Collection.
*
* @param value A Collection value.
*
* @return this.
*/
2014-11-05 04:42:08 +01:00
public JSONArray put(final Collection<Object> value) {
this.put(new JSONArray(value));
return this;
}
2015-02-23 02:32:27 +01:00
/**
* Append a double value. This increases the array's length by one.
*
2014-12-18 03:15:11 +01:00
* @param value A double value.
*
* @return this.
2014-12-18 03:15:11 +01:00
*
* @throws JSONException if the value is not finite.
*/
2014-11-05 04:42:08 +01:00
public JSONArray put(final double value) throws JSONException {
2014-11-21 23:45:46 +01:00
final Double d = value;
JSONObject.testValidity(d);
this.put(d);
return this;
}
2015-02-23 02:32:27 +01:00
/**
* Append an int value. This increases the array's length by one.
*
2014-12-18 03:15:11 +01:00
* @param value An int value.
*
* @return this.
*/
2014-11-05 04:42:08 +01:00
public JSONArray put(final int value) {
this.put(new Integer(value));
return this;
}
2015-02-23 02:32:27 +01:00
/**
* Append an long value. This increases the array's length by one.
*
2014-12-18 03:15:11 +01:00
* @param value A long value.
*
* @return this.
*/
2014-11-05 04:42:08 +01:00
public JSONArray put(final long value) {
this.put(new Long(value));
return this;
}
2015-02-23 02:32:27 +01:00
/**
2014-12-18 03:15:11 +01:00
* Put a value in the JSONArray, where the value will be a JSONObject which is produced from a Map.
*
* @param value A Map value.
*
* @return this.
*/
2014-11-05 04:42:08 +01:00
public JSONArray put(final Map<String, Object> value) {
this.put(new JSONObject(value));
return this;
}
2015-02-23 02:32:27 +01:00
/**
* Append an object value. This increases the array's length by one.
*
2014-12-18 03:15:11 +01:00
* @param value An object value. The value should be a Boolean, Double, Integer, JSONArray, JSONObject, Long, or
* String, or the JSONObject.NULL object.
*
* @return this.
*/
2014-11-05 04:42:08 +01:00
public JSONArray put(final Object value) {
this.myArrayList.add(value);
return this;
}
2015-02-23 02:32:27 +01:00
/**
2014-12-18 03:15:11 +01:00
* 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.
*
* @param index The subscript.
* @param value A boolean value.
*
* @return this.
2014-12-18 03:15:11 +01:00
*
* @throws JSONException If the index is negative.
*/
2014-11-05 04:42:08 +01:00
public JSONArray put(final int index, final boolean value) throws JSONException {
this.put(index, value ? Boolean.TRUE : Boolean.FALSE);
return this;
}
2015-02-23 02:32:27 +01:00
/**
2014-12-18 03:15:11 +01:00
* Put a value in the JSONArray, where the value will be a JSONArray which is produced from a Collection.
*
* @param index The subscript.
* @param value A Collection value.
*
* @return this.
2014-12-18 03:15:11 +01:00
*
* @throws JSONException If the index is negative or if the value is not finite.
*/
2014-11-05 04:42:08 +01:00
public JSONArray put(final int index, final Collection<Object> value) throws JSONException {
this.put(index, new JSONArray(value));
return this;
}
2015-02-23 02:32:27 +01:00
/**
2014-12-18 03:15:11 +01:00
* 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.
*
* @param index The subscript.
* @param value A double value.
*
* @return this.
2014-12-18 03:15:11 +01:00
*
* @throws JSONException If the index is negative or if the value is not finite.
*/
2014-11-05 04:42:08 +01:00
public JSONArray put(final int index, final double value) throws JSONException {
this.put(index, new Double(value));
return this;
}
2015-02-23 02:32:27 +01:00
/**
2014-12-18 03:15:11 +01:00
* 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.
*
* @param index The subscript.
* @param value An int value.
*
* @return this.
2014-12-18 03:15:11 +01:00
*
* @throws JSONException If the index is negative.
*/
2014-11-05 04:42:08 +01:00
public JSONArray put(final int index, final int value) throws JSONException {
this.put(index, new Integer(value));
return this;
}
2015-02-23 02:32:27 +01:00
/**
2014-12-18 03:15:11 +01:00
* 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.
*
* @param index The subscript.
* @param value A long value.
*
* @return this.
2014-12-18 03:15:11 +01:00
*
* @throws JSONException If the index is negative.
*/
2014-11-05 04:42:08 +01:00
public JSONArray put(final int index, final long value) throws JSONException {
this.put(index, new Long(value));
return this;
}
2015-02-23 02:32:27 +01:00
/**
2014-12-18 03:15:11 +01:00
* Put a value in the JSONArray, where the value will be a JSONObject that is produced from a Map.
*
* @param index The subscript.
* @param value The Map value.
*
* @return this.
2014-12-18 03:15:11 +01:00
*
* @throws JSONException If the index is negative or if the the value is an invalid number.
*/
2014-11-05 04:42:08 +01:00
public JSONArray put(final int index, final Map<String, Object> value) throws JSONException {
this.put(index, new JSONObject(value));
return this;
}
2015-02-23 02:32:27 +01:00
/**
2014-12-18 03:15:11 +01:00
* 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.
*
* @param index The subscript.
* @param value The value to put into the array. The value should be a Boolean, Double, Integer, JSONArray,
* JSONObject, Long, or String, or the JSONObject.NULL object.
*
* @return this.
2014-12-18 03:15:11 +01:00
*
* @throws JSONException If the index is negative or if the the value is an invalid number.
*/
2014-11-05 04:42:08 +01:00
public JSONArray put(final int index, final Object value) throws JSONException {
JSONObject.testValidity(value);
if (index < 0) {
throw new JSONException("JSONArray[" + index + "] not found.");
}
if (index < this.length()) {
this.myArrayList.set(index, value);
2014-12-18 03:15:11 +01:00
} else {
while (index != this.length()) {
this.put(JSONObject.NULL);
}
this.put(value);
}
return this;
}
2015-02-23 02:32:27 +01:00
/**
* Remove an index and close the hole.
*
2014-12-18 03:15:11 +01:00
* @param index The index of the element to be removed.
*
* @return The value that was associated with the index, or null if there was no value.
*/
2014-11-05 04:42:08 +01:00
public Object remove(final int index) {
return (index >= 0) && (index < this.length()) ? this.myArrayList.remove(index) : null;
}
2015-02-23 02:32:27 +01:00
/**
2014-12-18 03:15:11 +01:00
* Determine if two JSONArrays are similar. They must contain similar sequences.
*
* @param other The other JSONArray
*
* @return true if they are equal
*/
2014-11-05 04:42:08 +01:00
public boolean similar(final Object other) {
if (!(other instanceof JSONArray)) {
return false;
}
2014-11-05 04:42:08 +01:00
final int len = this.length();
if (len != ((JSONArray) other).length()) {
return false;
}
for (int i = 0; i < len; i += 1) {
2014-11-05 04:42:08 +01:00
final Object valueThis = this.get(i);
final Object valueOther = ((JSONArray) other).get(i);
if (valueThis instanceof JSONObject) {
2014-11-05 04:42:08 +01:00
if (!((JSONObject) valueThis).similar(valueOther)) {
return false;
}
2014-12-18 03:15:11 +01:00
} else if (valueThis instanceof JSONArray) {
2014-11-05 04:42:08 +01:00
if (!((JSONArray) valueThis).similar(valueOther)) {
return false;
}
2014-12-18 03:15:11 +01:00
} else if (!valueThis.equals(valueOther)) {
return false;
}
}
return true;
}
2015-02-23 02:32:27 +01:00
/**
2014-12-18 03:15:11 +01:00
* Produce a JSONObject by combining a JSONArray of names with the values of this JSONArray.
*
2014-12-18 03:15:11 +01:00
* @param names A JSONArray containing a list of key strings. These will be paired with the values.
*
* @return A JSONObject, or null if there are no names or if this JSONArray has no values.
*
* @throws JSONException If any of the names are null.
*/
2014-11-05 04:42:08 +01:00
public JSONObject toJSONObject(final JSONArray names) throws JSONException {
if ((names == null) || (names.length() == 0) || (this.length() == 0)) {
return null;
}
2014-11-05 04:42:08 +01:00
final JSONObject jo = new JSONObject();
for (int i = 0; i < names.length(); i += 1) {
jo.put(names.getString(i), this.opt(i));
}
return jo;
}
2015-02-23 02:32:27 +01:00
/**
2014-12-18 03:15:11 +01:00
* 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.
2015-03-13 08:05:06 +01:00
*
* Warning: This method assumes that the data structure is acyclical.
*
2014-12-18 03:15:11 +01:00
* @return a printable, displayable, transmittable representation of the array.
*/
2014-11-05 04:42:08 +01:00
@Override
public String toString() {
try {
return this.toString(0);
2014-12-18 03:15:11 +01:00
} catch (final Exception e) {
return null;
}
}
2015-02-23 02:32:27 +01:00
/**
2014-12-18 03:15:11 +01:00
* Make a prettyprinted JSON text of this JSONArray. Warning: This method assumes that the data structure is
* acyclical.
*
* @param indentFactor The number of spaces to add to each level of indentation.
*
* @return a printable, displayable, transmittable representation of the object, beginning with
* <code>[</code>&nbsp;<small>(left bracket)</small> and ending with <code>]</code> &nbsp;<small>(right
* bracket)</small>.
*
* @throws JSONException
*/
2014-11-05 04:42:08 +01:00
public String toString(final int indentFactor) throws JSONException {
final StringWriter sw = new StringWriter();
synchronized (sw.getBuffer()) {
return this.write(sw, indentFactor, 0).toString();
}
}
2015-02-23 02:32:27 +01:00
/**
2014-12-18 03:15:11 +01:00
* Write the contents of the JSONArray as JSON text to a writer. For compactness, no whitespace is added.
2015-03-13 08:05:06 +01:00
*
* Warning: This method assumes that the data structure is acyclical.
*
* @return The writer.
2014-12-18 03:15:11 +01:00
*
* @throws JSONException
*/
2014-11-05 04:42:08 +01:00
public Writer write(final Writer writer) throws JSONException {
return this.write(writer, 0, 0);
}
2015-02-23 02:32:27 +01:00
/**
2014-12-18 03:15:11 +01:00
* Write the contents of the JSONArray as JSON text to a writer. For compactness, no whitespace is added.
2015-03-13 08:05:06 +01:00
*
* Warning: This method assumes that the data structure is acyclical.
*
2014-12-18 03:15:11 +01:00
* @param indentFactor The number of spaces to add to each level of indentation.
* @param indent The indention of the top level.
*
* @return The writer.
2014-12-18 03:15:11 +01:00
*
* @throws JSONException
*/
2014-11-05 04:42:08 +01:00
Writer write(final Writer writer, final int indentFactor, final int indent) throws JSONException {
try {
boolean commanate = false;
2014-11-05 04:42:08 +01:00
final int length = this.length();
writer.write('[');
if (length == 1) {
2014-11-05 04:42:08 +01:00
JSONObject.writeValue(writer, this.myArrayList.get(0), indentFactor, indent);
2014-12-18 03:15:11 +01:00
} else if (length != 0) {
final int newindent = indent + indentFactor;
for (int i = 0; i < length; i += 1) {
if (commanate) {
writer.write(',');
}
if (indentFactor > 0) {
writer.write('\n');
}
JSONObject.indent(writer, newindent);
2014-11-05 04:42:08 +01:00
JSONObject.writeValue(writer, this.myArrayList.get(i), indentFactor, newindent);
commanate = true;
}
if (indentFactor > 0) {
writer.write('\n');
}
JSONObject.indent(writer, indent);
}
writer.write(']');
return writer;
2014-12-18 03:15:11 +01:00
} catch (final IOException e) {
throw new JSONException(e);
}
}
}