org.json

Class ListBasedJSONArray

java.lang.Object

org.json.ListBasedJSONArray

All Implemented Interfaces:

java.lang.Iterable<java.lang.Object>, JSONArray, JSONComponent

Direct Known Subclasses:

ImmutableJSONArray, WritableJSONArray

public abstract class ListBasedJSONArray
extends java.lang.Object
implements JSONArray

Constructor Summary

Constructors

Constructor and Description
ListBasedJSONArray(java.util.List<java.lang.Object> backingList)

Method Summary

Modifier and Type	Method and Description
<A extends JSONArray,O extends JSONObject> A	clone(JSONBuilder<A,O> builder)
boolean	equals(java.lang.Object obj)
boolean	equalsList(java.util.List<java.lang.Object> list)
java.lang.Object	get(int index) Get the object value associated with an index.
protected java.util.List<java.lang.Object>	getBackingList()
boolean	getBoolean(int index) Get the boolean value associated with an index.
double	getDouble(int index) Get the double value associated with an index.
int	getInt(int index) Get the int value associated with an index.
ListBasedJSONArray	getJSONArray(int index) Get the JSONArray associated with an index.
MapBasedJSONObject	getJSONObject(int index) Get the JSONObject associated with an index.
long	getLong(int index) Get the long value associated with an index.
java.lang.String	getString(int index) Get the string associated with an index.
int	hashCode()
int	indexOf(java.lang.Object value)
boolean	isNull(int index) Determine if the value is null.
java.util.Iterator<java.lang.Object>	iterator()
int	length() Get the number of elements in the JSONArray, included nulls.
java.lang.Object	opt(int index) Get the optional object value associated with an index.
boolean	optBoolean(int index) Get the optional boolean value associated with an index.
boolean	optBoolean(int index, boolean defaultValue) Get the optional boolean value associated with an index.
double	optDouble(int index) Get the optional double value associated with an index.
double	optDouble(int index, double defaultValue) Get the optional double value associated with an index.
int	optInt(int index) Get the optional int value associated with an index.
int	optInt(int index, int defaultValue) Get the optional int value associated with an index.
ListBasedJSONArray	optJSONArray(int index) Get the optional JSONArray associated with an index.
JSONObject	optJSONObject(int index) Get the optional JSONObject associated with an index.
long	optLong(int index) Get the optional long value associated with an index.
long	optLong(int index, long defaultValue) Get the optional long value associated with an index.
java.lang.String	optString(int index) Get the optional string value associated with an index.
java.lang.String	optString(int index, java.lang.String defaultValue) Get the optional string associated with an index.
ListBasedJSONArray	put(boolean value) Append a boolean value.
ListBasedJSONArray	put(double value) Append a double value.
ListBasedJSONArray	put(int value) Append an int value.
ListBasedJSONArray	put(int index, boolean value) Put or replace a boolean value in the JSONArray.
ListBasedJSONArray	put(int index, double value) Put or replace a double value.
ListBasedJSONArray	put(int index, int value) Put or replace an int value.
ListBasedJSONArray	put(int index, long value) Put or replace a long value.
ListBasedJSONArray	put(int index, java.lang.Object value) Put or replace an object value in the JSONArray.
ListBasedJSONArray	put(long value) Append an long value.
ListBasedJSONArray	put(java.lang.Object value) Append an object value.
java.lang.Object	remove(int index) Remove an index and close the hole.
boolean	remove(java.lang.Object object) Remove the first instance of an Object from the array.
java.lang.String	toString() Make a JSON text of this JSONArray.
java.lang.String	toString(int indentFactor) Make a prettyprinted JSON text of this JSONArray.
java.lang.String	toString(int indentFactor, int indent) Make a prettyprinted JSON text of this JSONArray.
java.lang.Appendable	write(java.lang.Appendable writer) Write the contents of the JSONArray as JSON text to a writer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ListBasedJSONArray

public ListBasedJSONArray(java.util.List<java.lang.Object> backingList)

Method Detail

getBackingList

protected java.util.List<java.lang.Object> getBackingList()

get

public java.lang.Object get(int index)

Get the object value associated with an index.

Specified by:

get in interface JSONArray

Parameters:

index - The index must be between 0 and length() - 1.

Returns:

An object value.

getBoolean

public boolean getBoolean(int index)
                   throws JSONException

Get the boolean value associated with an index. The string values "true" and "false" are converted to boolean.

Specified by:

getBoolean in interface JSONArray

Parameters:

index - The index must be between 0 and length() - 1.

Returns:

The truth.

Throws:

JSONException - If there is no value for the index or if the value is not convertible to boolean.

getDouble

public double getDouble(int index)
                 throws JSONException

Get the double value associated with an index.

Specified by:

getDouble in interface JSONArray

Parameters:

index - The index must be between 0 and length() - 1.

Returns:

The value.

Throws:

JSONException - If the key is not found or if the value cannot be converted to a number.

getInt

public int getInt(int index)
           throws JSONException

Get the int value associated with an index.

Specified by:

getInt in interface JSONArray

Parameters:

index - The index must be between 0 and length() - 1.

Returns:

The value.

Throws:

JSONException - If the key is not found or if the value is not a number.

getJSONArray

public ListBasedJSONArray getJSONArray(int index)
                                throws JSONException

Get the JSONArray associated with an index.

Specified by:

getJSONArray in interface JSONArray

Parameters:

index - The index must be between 0 and length() - 1.

Returns:

A JSONArray value.

Throws:

JSONException - If there is no value for the index. or if the value is not a JSONArray

getJSONObject

public MapBasedJSONObject getJSONObject(int index)
                                 throws JSONException

Get the JSONObject associated with an index.

Specified by:

getJSONObject in interface JSONArray

Parameters:

index - subscript

Returns:

A JSONObject value.

Throws:

JSONException - If there is no value for the index or if the value is not a JSONObject

getLong

public long getLong(int index)
             throws JSONException

Get the long value associated with an index.

Specified by:

getLong in interface JSONArray

Parameters:

index - The index must be between 0 and length() - 1.

Returns:

The value.

Throws:

JSONException - If the key is not found or if the value cannot be converted to a number.

getString

public java.lang.String getString(int index)
                           throws JSONException

Get the string associated with an index.

Specified by:

getString in interface JSONArray

Parameters:

index - The index must be between 0 and length() - 1.

Returns:

A string value.

Throws:

JSONException - If there is no value for the index.

isNull

public boolean isNull(int index)

Determine if the value is null.

Specified by:

isNull in interface JSONArray

Parameters:

index - The index must be between 0 and length() - 1.

Returns:

true if the value at the index is null, or if there is no value.

length

public int length()

Get the number of elements in the JSONArray, included nulls.

Specified by:

length in interface JSONArray

Returns:

The length (or size).

opt

public java.lang.Object opt(int index)

Get the optional object value associated with an index.

Specified by:

opt in interface JSONArray

Parameters:

index - The index must be between 0 and length() - 1.

Returns:

An object value, or null if there is no object at that index.

optBoolean

public boolean optBoolean(int 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 Boolean.TRUE or the String "true".

Specified by:

optBoolean in interface JSONArray

Parameters:

index - The index must be between 0 and length() - 1.

Returns:

The truth.

optBoolean

public boolean optBoolean(int index,
                          boolean defaultValue)

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).

Specified by:

optBoolean in interface JSONArray

Parameters:

index - The index must be between 0 and length() - 1.

defaultValue - A boolean default.

Returns:

The truth.

optDouble

public double optDouble(int index)

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.

Specified by:

optDouble in interface JSONArray

Parameters:

index - The index must be between 0 and length() - 1.

Returns:

The value.

optDouble

public double optDouble(int index,
                        double defaultValue)

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.

Specified by:

optDouble in interface JSONArray

Parameters:

index - subscript

defaultValue - The default value.

Returns:

The value.

optInt

public int optInt(int index)

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.

Specified by:

optInt in interface JSONArray

Parameters:

index - The index must be between 0 and length() - 1.

Returns:

The value.

optInt

public int optInt(int index,
                  int defaultValue)

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.

Specified by:

optInt in interface JSONArray

Parameters:

index - The index must be between 0 and length() - 1.

defaultValue - The default value.

Returns:

The value.

optJSONArray

public ListBasedJSONArray optJSONArray(int index)

Get the optional JSONArray associated with an index.

Specified by:

optJSONArray in interface JSONArray

Parameters:

index - subscript

Returns:

A JSONArray value, or null if the index has no value, or if the value is not a JSONArray.

optJSONObject

public JSONObject optJSONObject(int index)

Get the optional JSONObject associated with an index. Null is returned if the key is not found, or null if the index has no value, or if the value is not a JSONObject.

Specified by:

optJSONObject in interface JSONArray

Parameters:

index - The index must be between 0 and length() - 1.

Returns:

A JSONObject value.

optLong

public long optLong(int index)

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.

Specified by:

optLong in interface JSONArray

Parameters:

index - The index must be between 0 and length() - 1.

Returns:

The value.

optLong

public long optLong(int index,
                    long defaultValue)

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.

Specified by:

optLong in interface JSONArray

Parameters:

index - The index must be between 0 and length() - 1.

defaultValue - The default value.

Returns:

The value.

optString

public java.lang.String optString(int index)

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.

Specified by:

optString in interface JSONArray

Parameters:

index - The index must be between 0 and length() - 1.

Returns:

A String value.

optString

public java.lang.String optString(int index,
                                  java.lang.String defaultValue)

Get the optional string associated with an index. The defaultValue is returned if the key is not found.

Specified by:

optString in interface JSONArray

Parameters:

index - The index must be between 0 and length() - 1.

defaultValue - The default value.

Returns:

A String value.

put

public ListBasedJSONArray put(boolean value)

Append a boolean value. This increases the array's length by one.

Specified by:

put in interface JSONArray

Parameters:

value - A boolean value.

Returns:

this.

put

public ListBasedJSONArray put(double value)
                       throws JSONException

Append a double value. This increases the array's length by one.

Specified by:

put in interface JSONArray

Parameters:

value - A double value.

Returns:

this.

Throws:

JSONException - if the value is not finite.

put

public ListBasedJSONArray put(int value)

Append an int value. This increases the array's length by one.

Specified by:

put in interface JSONArray

Parameters:

value - An int value.

Returns:

this.

put

public ListBasedJSONArray put(long value)

Append an long value. This increases the array's length by one.

Specified by:

put in interface JSONArray

Parameters:

value - A long value.

Returns:

this.

put

public ListBasedJSONArray put(java.lang.Object value)

Append an object value. This increases the array's length by one.

Specified by:

put in interface JSONArray

Parameters:

value - An object value. The value should be a Boolean, Double, Integer, JSONArray, JSONObject, Long, or String, or the JSONObject.NULL object.

Returns:

this.

put

public ListBasedJSONArray put(int index,
                              boolean value)
                       throws JSONException

Put or replace a boolean value in the JSONArray. If the index is greater than the length of the JSONArray, then null elements will be added as necessary to pad it out.

Specified by:

put in interface JSONArray

Parameters:

index - The subscript.

value - A boolean value.

Returns:

this.

Throws:

JSONException - If the index is negative.

put

public ListBasedJSONArray put(int index,
                              double value)
                       throws JSONException

Put or replace a double value. If the index is greater than the length of the JSONArray, then null elements will be added as necessary to pad it out.

Specified by:

put in interface JSONArray

Parameters:

index - The subscript.

value - A double value.

Returns:

this.

Throws:

JSONException - If the index is negative or if the value is not finite.

put

public ListBasedJSONArray put(int index,
                              int value)
                       throws JSONException

Put or replace an int value. If the index is greater than the length of the JSONArray, then null elements will be added as necessary to pad it out.

Specified by:

put in interface JSONArray

Parameters:

index - The subscript.

value - An int value.

Returns:

this.

Throws:

JSONException - If the index is negative.

put

public ListBasedJSONArray put(int index,
                              long value)
                       throws JSONException

Put or replace a long value. If the index is greater than the length of the JSONArray, then null elements will be added as necessary to pad it out.

Specified by:

put in interface JSONArray

Parameters:

index - The subscript.

value - A long value.

Returns:

this.

Throws:

JSONException - If the index is negative.

put

public ListBasedJSONArray put(int index,
                              java.lang.Object value)
                       throws JSONException

Put or replace an object value in the JSONArray. If the index is greater than the length of the JSONArray, then null elements will be added as necessary to pad it out.

Specified by:

put in interface JSONArray

Parameters:

index - The subscript.

value - The value to put into the array. The value should be a Boolean, Double, Integer, JSONArray, JSONObject, Long, or String, or the JSONObject.NULL object.

Returns:

this.

Throws:

JSONException - If the index is negative or if the the value is an invalid number.

remove

public java.lang.Object remove(int index)

Remove an index and close the hole.

Specified by:

remove in interface JSONArray

Parameters:

index - The index of the element to be removed.

Returns:

The value that was associated with the index, or null if there was no value.

remove

public boolean remove(java.lang.Object object)

Description copied from interface: JSONArray

Remove the first instance of an Object from the array.

Specified by:

remove in interface JSONArray

Parameters:

object - The object to be removed from the array.

Returns:

true if it is has been removed.

toString

public java.lang.String toString()

Make a JSON text of this JSONArray. For compactness, no unnecessary whitespace is added. If it is not possible to produce a syntactically correct JSON text then null will be returned instead. This could occur if the array contains an invalid number.

Warning: This method assumes that the data structure is acyclical.

Specified by:

toString in interface JSONComponent

Overrides:

toString in class java.lang.Object

Returns:

a printable, displayable, transmittable representation of the array.

toString

public java.lang.String toString(int indentFactor)

Make a prettyprinted JSON text of this JSONArray. Warning: This method assumes that the data structure is acyclical.

Specified by:

toString in interface JSONComponent

Parameters:

indentFactor - The number of spaces to add to each level of indentation.

Returns:

a printable, displayable, transmittable representation of the object, beginning with [ (left bracket) and ending with ] (right bracket).

toString

public final java.lang.String toString(int indentFactor,
                                       int indent)

Make a prettyprinted JSON text of this JSONArray. Warning: This method assumes that the data structure is acyclical.

Specified by:

toString in interface JSONComponent

Parameters:

indentFactor - The number of spaces to add to each level of indentation.

indent - The indention of the top level.

Returns:

a printable, displayable, transmittable representation of the array.

write

public java.lang.Appendable write(java.lang.Appendable writer)
                           throws java.io.IOException

Write the contents of the JSONArray as JSON text to a writer. For compactness, no whitespace is added.

Warning: This method assumes that the data structure is acyclical.

Specified by:

write in interface JSONComponent

Returns:

The writer.

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equalsList

public boolean equalsList(java.util.List<java.lang.Object> list)

Specified by:

equalsList in interface JSONArray

iterator

public java.util.Iterator<java.lang.Object> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.lang.Object>

Specified by:

iterator in interface JSONArray

indexOf

public int indexOf(java.lang.Object value)

Specified by:

indexOf in interface JSONArray

clone

public <A extends JSONArray,O extends JSONObject> A clone(JSONBuilder<A,O> builder)
                                                   throws JSONException

Specified by:

clone in interface JSONArray

Throws:

JSONException