Please wait. This can take some minutes ...
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
panda.bind.json.JsonArray Maven / Gradle / Ivy
Go to download
Panda Core is the core module of Panda Framework, it contains commonly used utility classes similar to apache-commons.
package panda.bind.json;
import java.io.InputStream;
import java.io.Reader;
import java.lang.reflect.Array;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.Map;
import panda.io.stream.CharSequenceReader;
/**
* 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 JsonObject.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
.
*
*
* @see JSON.org
*/
public class JsonArray extends ArrayList {
/**
* serialVersionUID
*/
private static final long serialVersionUID = 1L;
/**
* Construct an empty JsonArray.
*/
public JsonArray() {
}
/**
* @param initialCapacity the initial capacity of the list
*/
public JsonArray(int initialCapacity) {
super(initialCapacity);
}
/**
* Construct a JsonArray from a Collection.
*
* @param collection A Collection.
*/
public JsonArray(Collection> collection) {
if (collection != null) {
Iterator> iter = collection.iterator();
while (iter.hasNext()) {
this.add(iter.next());
}
}
}
/**
* Construct a JsonArray from an array
*
* @param array array object
* @throws JsonException If not an array.
*/
public JsonArray(Object array) throws JsonException {
if (array.getClass().isArray()) {
int length = Array.getLength(array);
for (int i = 0; i < length; i += 1) {
this.add(Array.get(array, i));
}
}
else {
throw new JsonException("JsonArray initial value should be a string or collection or array.");
}
}
/**
* Get the boolean value associated with an index.
*
* @param index The index must be between 0 and length() - 1.
* @return The truth.
* @throws JsonException If there is no value for the index or if the value is not a Boolean object.
*/
public boolean getBoolean(int index) throws JsonException {
Object object = this.get(index);
if (object instanceof Boolean) {
return ((Boolean)object).booleanValue();
}
throw new JsonException("JsonArray[" + index + "] is not a boolean.");
}
/**
* Get the double value associated with an index.
*
* @param index The index must be between 0 and length() - 1.
* @return The value.
* @throws JsonException If the key is not found or if the value is not a Number object.
*/
public double getDouble(int index) throws JsonException {
Object object = this.get(index);
if (object instanceof Number) {
return ((Number)object).doubleValue();
}
throw new JsonException("JsonArray[" + index + "] is not a number.");
}
/**
* Get the int value associated with an index.
*
* @param index The index must be between 0 and length() - 1.
* @return The value.
* @throws JsonException If the key is not found or if the value is not a number.
*/
public int getInt(int index) throws JsonException {
Object object = this.get(index);
if (object instanceof Number) {
return ((Number)object).intValue();
}
throw new JsonException("JsonArray[" + index + "] is not a number.");
}
/**
* Get the JsonArray associated with an index.
*
* @param index The index must be between 0 and length() - 1.
* @return A JsonArray value.
* @throws JsonException If there is no value for the index. or if the value is not a JsonArray
*/
public JsonArray getJsonArray(int index) throws JsonException {
Object object = this.get(index);
if (object instanceof JsonArray) {
return (JsonArray)object;
}
throw new JsonException("JsonArray[" + index + "] is not a JsonArray.");
}
/**
* Get the JsonObject associated with an index.
*
* @param index subscript
* @return A JsonObject value.
* @throws JsonException If there is no value for the index or if the value is not a JsonObject
*/
public JsonObject getJsonObject(int index) throws JsonException {
Object object = this.get(index);
if (object instanceof JsonObject) {
return (JsonObject)object;
}
throw new JsonException("JsonArray[" + index + "] is not a JsonObject.");
}
/**
* Get the long value associated with an index.
*
* @param index The index must be between 0 and length() - 1.
* @return The value.
* @throws JsonException If the key is not found or if the value cannot be converted to a
* number.
*/
public long getLong(int index) throws JsonException {
Object object = this.get(index);
if (object instanceof Number) {
return ((Number)object).longValue();
}
throw new JsonException("JsonArray[" + index + "] is not a number.");
}
/**
* Get the string associated with an index.
*
* @param index The index must be between 0 and length() - 1.
* @return A string value.
* @throws JsonException If there is no string value for the index.
*/
public String getString(int index) throws JsonException {
Object object = this.get(index);
if (object instanceof String) {
return (String)object;
}
throw new JsonException("JsonArray[" + index + "] not a string.");
}
/**
* Determine if the value is null.
*
* @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.
*/
public boolean isNull(int index) {
return null == this.opt(index);
}
/**
* Get the number of elements in the JsonArray, included nulls.
*
* @return The length (or size).
*/
public int length() {
return this.size();
}
/**
* Get the optional object value associated with an index.
*
* @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.
*/
public Object opt(int index) {
return (index < 0 || index >= this.length()) ? null : this.get(index);
}
/**
* 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 a Boolean.TRUE.
*
* @param index The index must be between 0 and length() - 1.
* @return The truth.
*/
public boolean optBoolean(int index) {
return this.optBoolean(index, false);
}
/**
* 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 object.
*
* @param index The index must be between 0 and length() - 1.
* @param defaultValue A boolean default.
* @return The truth.
*/
public boolean optBoolean(int index, boolean defaultValue) {
Object object = this.get(index);
if (object instanceof Boolean) {
return (Boolean)object;
}
return defaultValue;
}
/**
* 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.
*
* @param index The index must be between 0 and length() - 1.
* @return The value.
*/
public double optDouble(int index) {
return this.optDouble(index, Double.NaN);
}
/**
* 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.
*
* @param index subscript
* @param defaultValue The default value.
* @return The value.
*/
public double optDouble(int index, double defaultValue) {
Object object = this.get(index);
if (object instanceof Number) {
return ((Number)object).doubleValue();
}
return defaultValue;
}
/**
* 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.
*
* @param index The index must be between 0 and length() - 1.
* @return The value.
*/
public int optInt(int index) {
return this.optInt(index, 0);
}
/**
* 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.
*
* @param index The index must be between 0 and length() - 1.
* @param defaultValue The default value.
* @return The value.
*/
public int optInt(int index, int defaultValue) {
Object object = this.get(index);
if (object instanceof Number) {
return ((Number)object).intValue();
}
return defaultValue;
}
/**
* Get the optional JsonArray associated with an index.
*
* @param index subscript
* @return A JsonArray value, or null if the index has no value, or if the value is not a
* JsonArray.
*/
public JsonArray optJsonArray(int index) {
Object o = this.opt(index);
return o instanceof JsonArray ? (JsonArray)o : null;
}
/**
* 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.
*/
public JsonObject optJsonObject(int index) {
Object o = this.opt(index);
return o instanceof JsonObject ? (JsonObject)o : null;
}
/**
* 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.
*
* @param index The index must be between 0 and length() - 1.
* @return The value.
*/
public long optLong(int index) {
return this.optLong(index, 0);
}
/**
* 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.
*
* @param index The index must be between 0 and length() - 1.
* @param defaultValue The default value.
* @return The value.
*/
public long optLong(int index, long defaultValue) {
Object object = this.get(index);
if (object instanceof Number) {
return ((Number)object).longValue();
}
return defaultValue;
}
/**
* Get the optional string value associated with an index. It returns null if there
* is no value at that index or if the value is not a string.
*
* @param index The index must be between 0 and length() - 1.
* @return A String value.
*/
public String optString(int index) {
return this.optString(index, null);
}
/**
* Get the optional string associated with an index. The defaultValue is returned if there
* is no value at that index or if the value is not a string.
*
* @param index The index must be between 0 and length() - 1.
* @param defaultValue The default value.
* @return A String value.
*/
public String optString(int index, String defaultValue) {
Object object = this.get(index);
if (object instanceof String) {
return (String)object;
}
return defaultValue;
}
/**
* Append a boolean value. This increases the array's length by one.
*
* @param value A boolean value.
* @return this.
*/
public JsonArray put(boolean value) {
this.put(value ? Boolean.TRUE : Boolean.FALSE);
return this;
}
/**
* 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.
*/
public JsonArray put(Collection> value) {
this.put(new JsonArray(value));
return this;
}
/**
* Append a double value. This increases the array's length by one.
*
* @param value A double value.
* @throws JsonException if the value is not finite.
* @return this.
*/
public JsonArray put(double value) throws JsonException {
this.put(new Double(value));
return this;
}
/**
* Append a float value. This increases the array's length by one.
*
* @param value A float value.
* @throws JsonException if the value is not finite.
* @return this.
*/
public JsonArray put(float value) throws JsonException {
this.put(new Float(value));
return this;
}
/**
* Append an int value. This increases the array's length by one.
*
* @param value An int value.
* @return this.
*/
public JsonArray put(int value) {
this.put(new Integer(value));
return this;
}
/**
* Append an long value. This increases the array's length by one.
*
* @param value A long value.
* @return this.
*/
public JsonArray put(long value) {
this.put(new Long(value));
return this;
}
/**
* 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.
*/
public JsonArray put(Map, ?> value) {
this.put(new JsonObject(value));
return this;
}
/**
* Append an object value. This increases the array's length by one.
*
* @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.
*/
public JsonArray put(Object value) {
this.add(value);
return this;
}
/**
* 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.
* @throws JsonException If the index is negative.
*/
public JsonArray put(int index, boolean value) throws JsonException {
this.put(index, value ? Boolean.TRUE : Boolean.FALSE);
return this;
}
/**
* 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.
* @throws JsonException If the index is negative or if the value is not finite.
*/
public JsonArray put(int index, Collection> value) throws JsonException {
this.put(index, new JsonArray(value));
return this;
}
/**
* 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.
* @throws JsonException If the index is negative or if the value is not finite.
*/
public JsonArray put(int index, double value) throws JsonException {
this.put(index, new Double(value));
return this;
}
/**
* 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.
* @throws JsonException If the index is negative.
*/
public JsonArray put(int index, int value) throws JsonException {
this.put(index, new Integer(value));
return this;
}
/**
* 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.
* @throws JsonException If the index is negative.
*/
public JsonArray put(int index, long value) throws JsonException {
this.put(index, new Long(value));
return this;
}
/**
* 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.
* @throws JsonException If the index is negative or if the the value is an invalid number.
*/
public JsonArray put(int index, Map, ?> value) throws JsonException {
this.put(index, new JsonObject(value));
return this;
}
/**
* 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.
* @throws JsonException If the index is negative or if the the value is an invalid number.
*/
public JsonArray put(int index, Object value) throws JsonException {
if (index < 0) {
throw new JsonException("JsonArray[" + index + "] not found.");
}
if (index < this.length()) {
this.set(index, value);
}
else {
while (index != this.length()) {
this.add(null);
}
this.put(value);
}
return this;
}
/**
* Replaces the element at the specified position in this list with the specified element.
*
* @param index index of the element to replace
* @param element element to be stored at the specified position
* @return the element previously at the specified position
* @throws IndexOutOfBoundsException {@inheritDoc}
*/
public Object set(int index, Object element) {
return super.set(index, JsonObject.wrap(element));
}
/**
* Appends the specified element to the end of this list.
*
* @param e element to be appended to this list
* @return true (as specified by {@link Collection#add})
*/
public boolean add(Object e) {
return super.add(JsonObject.wrap(e));
}
/**
* {@inheritDoc}
*/
public String toString() {
return Jsons.toJson(this);
}
public String toString(boolean pretty) {
return Jsons.toJson(this, pretty);
}
public String toString(int indent) {
return Jsons.toJson(this, indent);
}
public static JsonArray fromJson(InputStream json, String encoding) {
return Jsons.fromJson(json, encoding, JsonArray.class);
}
public static JsonArray fromJson(Reader json) {
return Jsons.fromJson(json, JsonArray.class);
}
public static JsonArray fromJson(CharSequence json) {
if (json == null) {
return null;
}
JsonTokener jt = new JsonTokener(new CharSequenceReader(json));
char c = jt.nextClean();
if (c != '[') {
json = "[" + json + "]";
}
return Jsons.fromJson(json, JsonArray.class);
}
}