SimpleJSONArray (SimpleJSON 1.1.0 API)

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractList<E>
  - - java.util.ArrayList<Object>
    - - org.bspfsystems.simplejson.SimpleJSONArray

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Object>, Collection<Object>, List<Object>, RandomAccess, JSONArray, JSONSerializable
```
public final class SimpleJSONArray
extends ArrayList<Object>
implements JSONArray
```
Represents a simple implementation of a JSONArray, which is a common, non-thread-safe data format for a collection of Objects.
The contents of the JSONArray are only validated as JSON values upon serialization (see JSONSerializable.serialize()). This means that all values added to a JSONArray must be recognized by the JSONParser for it to be considered a true JSONArray. Until such a recognition has been reached, the item should be considered a JSONSerializable ArrayList.

See Also:

Serialized Form

Field Summary
- Fields inherited from class java.util.AbstractList
  modCount

Constructor Summary

Constructors
Constructor and Description
`SimpleJSONArray()` Constructs a new `JSONArray`.
`SimpleJSONArray(@NotNull Collection<?> data)` Constructs a new `JSONArray` with the specified `Collection` of data loaded into the underlying `ArrayList` to start.
`SimpleJSONArray(int initialCapacity)` Constructs a new `JSONArray` with the specified initial capacity.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEntry(@Nullable Object value)` Adds the given value at the end of this `JSONArray`.
`@Nullable JSONArray`	`getArray(int index)` Gets the `JSONArray` value at the given index.
`@Nullable JSONArray`	`getArray(int index, @Nullable JSONArray def)` Gets the `JSONArray` value at the given index.
`boolean`	`getBoolean(int index)` Gets the boolean value at the given index.
`boolean`	`getBoolean(int index, boolean def)` Gets the boolean value at the given index.
`byte`	`getByte(int index)` Gets the byte value at the given index.
`byte`	`getByte(int index, byte def)` Gets the byte value at the given index.
`double`	`getDouble(int index)` Gets the double value at the given index.
`double`	`getDouble(int index, double def)` Gets the double value at the given index.
`float`	`getFloat(int index)` Gets the float value at the given index.
`float`	`getFloat(int index, float def)` Gets the float value at the given index.
`int`	`getInteger(int index)` Gets the integer value at the given index.
`int`	`getInteger(int index, int def)` Gets the integer value at the given index.
`long`	`getLong(int index)` Gets the long value at the given index.
`long`	`getLong(int index, long def)` Gets the long value at the given index.
`@Nullable JSONObject`	`getObject(int index)` Gets the `JSONObject` value at the given index.
`@Nullable JSONObject`	`getObject(int index, @Nullable JSONObject def)` Gets the `JSONObject` value at the given index.
`short`	`getShort(int index)` Gets the short value at the given index.
`short`	`getShort(int index, short def)` Gets the short value at the given index.
`@Nullable String`	`getString(int index)` Gets the `String` value at the given index.
`@Nullable String`	`getString(int index, @Nullable String def)` Gets the `String` value at the given index.
`void`	`insertEntry(int index, @Nullable Object value)` Inserts the given value at the given index, adding 1 to the index of every entry after the given index.
`boolean`	`isArray(int index)` Checks if there is a `JSONArray` value at the given index.
`boolean`	`isBoolean(int index)` Checks if there is a boolean value at the given index.
`boolean`	`isByte(int index)` Checks if there is a byte value at the given index.
`boolean`	`isDouble(int index)` Checks if there is a double value at the given index.
`boolean`	`isFloat(int index)` Checks if there is a float value at the given index.
`boolean`	`isInteger(int index)` Checks if there is an integer value at the given index.
`boolean`	`isLong(int index)` Checks if there is a long value at the given index.
`boolean`	`isNull(int index)` Checks if there is a null value at the given index.
`boolean`	`isObject(int index)` Checks if there is a `JSONObject` value at the given index.
`boolean`	`isShort(int index)` Checks if there is a short value at the given index.
`boolean`	`isString(int index)` Checks if there is a `String` value at the given index.
`@NotNull Iterator<Object>`	`iterator()` Gets an `Iterator` over the entries in this `JSONArray`.
`@NotNull String`	`serialize()` Serializes this `JSONSerializable` into a string.
`void`	`setEntry(int index, @Nullable Object value)` Sets the given index to the given value, overwriting any other value that was previously set there.
`int`	`size()` Gets the size of this `JSONArray`.
`void`	`unsetEntry(int index)` Removes the entry at the given index, subtracting 1 from the index of every entry after the given index.

Methods inherited from class java.util.ArrayList
add, add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList
equals, hashCode

Methods inherited from class java.util.AbstractCollection
containsAll, toString

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface java.util.List
containsAll, equals, hashCode

Methods inherited from interface java.util.Collection
parallelStream, stream

- Constructor Detail
  - SimpleJSONArray
```
public SimpleJSONArray()
```
    Constructs a new JSONArray.
    
    See Also:
    
    ArrayList()
  - SimpleJSONArray
```
public SimpleJSONArray(int initialCapacity)
```
    Constructs a new JSONArray with the specified initial capacity.
    
    Parameters:
    
    initialCapacity - The initial capacity that the underlying ArrayList should allocate for.
    
    See Also:
    
    ArrayList(int)
  - SimpleJSONArray
```
public SimpleJSONArray(@NotNull
                       @NotNull Collection<?> data)
```
    Constructs a new JSONArray with the specified Collection of data loaded into the underlying ArrayList to start.
    
    Parameters:
    
    data - The Collection whose data will be placed into the JSONArray to start.
    
    See Also:
    
    ArrayList(Collection)
- Method Detail
  - size
```
public int size()
```
    Gets the size of this JSONArray.
    
    Specified by:
    
    size in interface Collection<Object>
    
    Specified by:
    
    size in interface List<Object>
    
    Specified by:
    
    size in interface JSONArray
    
    Overrides:
    
    size in class ArrayList<Object>
    
    Returns:
    
    The size of this JSONArray.
  - iterator
```
@NotNull
public @NotNull Iterator<Object> iterator()
```
    Gets an Iterator over the entries in this JSONArray.
    
    Specified by:
    
    iterator in interface Iterable<Object>
    
    Specified by:
    
    iterator in interface Collection<Object>
    
    Specified by:
    
    iterator in interface List<Object>
    
    Specified by:
    
    iterator in interface JSONArray
    
    Overrides:
    
    iterator in class ArrayList<Object>
    
    Returns:
    
    An Iterator over the entries in this JSONArray.
  - addEntry
```
public void addEntry(@Nullable
                     @Nullable Object value)
```
    Adds the given value at the end of this JSONArray.
    
    Specified by:
    
    addEntry in interface JSONArray
    
    Parameters:
    
    value - The value to add.
  - insertEntry
```
public void insertEntry(int index,
                        @Nullable
                        @Nullable Object value)
                 throws IndexOutOfBoundsException
```
    Inserts the given value at the given index, adding 1 to the index of every entry after the given index.
    If the given index is less than 0 or greater than the current size of this JSONArray minus 1, an IndexOutOfBoundsException will be thrown.
    
    Specified by:
    
    insertEntry in interface JSONArray
    
    Parameters:
    
    index - The index to insert into.
    
    value - The value to insert.
    
    Throws:
    
    IndexOutOfBoundsException
  - setEntry
```
public void setEntry(int index,
                     @Nullable
                     @Nullable Object value)
              throws IndexOutOfBoundsException
```
    Sets the given index to the given value, overwriting any other value that was previously set there.
    If the given index is less than 0 or greater than the current size of this JSONArray minus 1, an IndexOutOfBoundsException will be thrown.
    
    Specified by:
    
    setEntry in interface JSONArray
    
    Parameters:
    
    index - The index to set at.
    
    value - The value to set.
    
    Throws:
    
    IndexOutOfBoundsException
  - unsetEntry
```
public void unsetEntry(int index)
                throws IndexOutOfBoundsException
```
    Removes the entry at the given index, subtracting 1 from the index of every entry after the given index.
    If the given index is less than 0 or greater than the current size of this JSONArray minus 1, an IndexOutOfBoundsException will be thrown.
    
    Specified by:
    
    unsetEntry in interface JSONArray
    
    Parameters:
    
    index - The index of the entry to remove.
    
    Throws:
    
    IndexOutOfBoundsException
  - isNull
```
public boolean isNull(int index)
```
    Checks if there is a null value at the given index.
    This will return false if the index is outside this JSONArray's bounds, or if there is an entry at the index and the value is not null.
    This will return true if the d at the index is null (the index must be within this JSONArray's bounds), regardless of what type of Object the entry is supposed to be.
    
    Specified by:
    
    isNull in interface JSONArray
    
    Parameters:
    
    index - The index to check.
    
    Returns:
    
    true if there is a null entry at the given index, false otherwise.
  - isBoolean
```
public boolean isBoolean(int index)
```
    Checks if there is a boolean value at the given index.
    This will return false if the index is out of this JSONArray's bounds, or if there is no entry (null), or if the entry is not a boolean.
    
    Specified by:
    
    isBoolean in interface JSONArray
    
    Parameters:
    
    index - The index to check.
    
    Returns:
    
    true if there is a boolean at the given index, false otherwise.
  - getBoolean
```
public boolean getBoolean(int index)
```
    Gets the boolean value at the given index.
    If the index is out of the JSONArray's bounds, no entry set (null), or the value at the index is not a boolean, false will be returned.
    
    Specified by:
    
    getBoolean in interface JSONArray
    
    Parameters:
    
    index - The index of the boolean to retrieve.
    
    Returns:
    
    The boolean value at the index.
    
    See Also:
    
    JSONArray.getBoolean(int, boolean)
  - getBoolean
```
public boolean getBoolean(int index,
                          boolean def)
```
    Gets the boolean value at the given index.
    If the index is out of the JSONArray's bounds, no entry set (null), or the value at the index is not a boolean, the default value will be returned.
    
    Specified by:
    
    getBoolean in interface JSONArray
    
    Parameters:
    
    index - The index of the boolean to retrieve.
    
    def - The default value.
    
    Returns:
    
    The boolean value at the index.
  - isByte
```
public boolean isByte(int index)
```
    Checks if there is a byte value at the given index.
    This will return false if the index is out of this JSONArray's bounds, or if there is no entry (null), or if the entry is not a byte.
    
    Specified by:
    
    isByte in interface JSONArray
    
    Parameters:
    
    index - The index to check.
    
    Returns:
    
    true if there is a byte at the given index, false otherwise.
  - getByte
```
public byte getByte(int index)
```
    Gets the byte value at the given index.
    If the index is out of the JSONArray's bounds, no entry set (null), or the value at the index is not a byte, (byte) 0 will be returned.
    
    Specified by:
    
    getByte in interface JSONArray
    
    Parameters:
    
    index - The index of the byte to retrieve.
    
    Returns:
    
    The byte value at the index.
    
    See Also:
    
    JSONArray.getByte(int, byte)
  - getByte
```
public byte getByte(int index,
                    byte def)
```
    Gets the byte value at the given index.
    If the index is out of the JSONArray's bounds, no entry set (null), or the value at the index is not a byte, the default value will be returned.
    
    Specified by:
    
    getByte in interface JSONArray
    
    Parameters:
    
    index - The index of the byte to retrieve.
    
    def - The default value.
    
    Returns:
    
    The byte value at the index.
  - isShort
```
public boolean isShort(int index)
```
    Checks if there is a short value at the given index.
    This will return false if the index is out of this JSONArray's bounds, or if there is no entry (null), or if the entry is not a short.
    
    Specified by:
    
    isShort in interface JSONArray
    
    Parameters:
    
    index - The index to check.
    
    Returns:
    
    true if there is a short at the given index, false otherwise.
  - getShort
```
public short getShort(int index)
```
    Gets the short value at the given index.
    If the index is out of the JSONArray's bounds, no entry set (null), or the value at the index is not a short, (short) 0 will be returned.
    
    Specified by:
    
    getShort in interface JSONArray
    
    Parameters:
    
    index - The index of the short to retrieve.
    
    Returns:
    
    The short value at the index.
    
    See Also:
    
    JSONArray.getShort(int, short)
  - getShort
```
public short getShort(int index,
                      short def)
```
    Gets the short value at the given index.
    If the index is out of the JSONArray's bounds, no entry set (null), or the value at the index is not a short, the default value will be returned.
    
    Specified by:
    
    getShort in interface JSONArray
    
    Parameters:
    
    index - The index of the short to retrieve.
    
    def - The default value.
    
    Returns:
    
    The short value at the index.
  - isInteger
```
public boolean isInteger(int index)
```
    Checks if there is an integer value at the given index.
    This will return false if the index is out of this JSONArray's bounds, or if there is no entry (null), or if the entry is not an integer.
    
    Specified by:
    
    isInteger in interface JSONArray
    
    Parameters:
    
    index - The index to check.
    
    Returns:
    
    true if there is an integer at the given index, false otherwise.
  - getInteger
```
public int getInteger(int index)
```
    Gets the integer value at the given index.
    If the index is out of the JSONArray's bounds, no entry set (null), or the value at the index is not an integer, 0 will be returned.
    
    Specified by:
    
    getInteger in interface JSONArray
    
    Parameters:
    
    index - The index of the integer to retrieve.
    
    Returns:
    
    The integer value at the index.
    
    See Also:
    
    JSONArray.getInteger(int, int)
  - getInteger
```
public int getInteger(int index,
                      int def)
```
    Gets the integer value at the given index.
    If the index is out of the JSONArray's bounds, no entry set (null), or the value at the index is not an integer, the default value will be returned.
    
    Specified by:
    
    getInteger in interface JSONArray
    
    Parameters:
    
    index - The index of the integer to retrieve.
    
    def - The default value.
    
    Returns:
    
    The integer value at the index.
  - isLong
```
public boolean isLong(int index)
```
    Checks if there is a long value at the given index.
    This will return false if the index is out of this JSONArray's bounds, or if there is no entry (null), or if the entry is not a long.
    
    Specified by:
    
    isLong in interface JSONArray
    
    Parameters:
    
    index - The index to check.
    
    Returns:
    
    true if there is a long at the given index, false otherwise.
  - getLong
```
public long getLong(int index)
```
    Gets the long value at the given index.
    If the index is out of the JSONArray's bounds, no entry set (null), or the value at the index is not a long, 0L will be returned.
    
    Specified by:
    
    getLong in interface JSONArray
    
    Parameters:
    
    index - The index of the long to retrieve.
    
    Returns:
    
    The long value at the index.
    
    See Also:
    
    JSONArray.getLong(int, long)
  - getLong
```
public long getLong(int index,
                    long def)
```
    Gets the long value at the given index.
    If the index is out of the JSONArray's bounds, no entry set (null), or the value at the index is not a long, the default value will be returned.
    
    Specified by:
    
    getLong in interface JSONArray
    
    Parameters:
    
    index - The index of the long to retrieve.
    
    def - The default value.
    
    Returns:
    
    The long value at the index.
  - isFloat
```
public boolean isFloat(int index)
```
    Checks if there is a float value at the given index.
    This will return false if the index is out of this JSONArray's bounds, or if there is no entry (null), or if the entry is not a float.
    
    Specified by:
    
    isFloat in interface JSONArray
    
    Parameters:
    
    index - The index to check.
    
    Returns:
    
    true if there is a float at the given index, false otherwise.
  - getFloat
```
public float getFloat(int index)
```
    Gets the float value at the given index.
    If the index is out of the JSONArray's bounds, no entry set (null), or the value at the index is not a float, 0.0F will be returned.
    
    Specified by:
    
    getFloat in interface JSONArray
    
    Parameters:
    
    index - The index of the float to retrieve.
    
    Returns:
    
    The float value at the index.
    
    See Also:
    
    JSONArray.getFloat(int, float)
  - getFloat
```
public float getFloat(int index,
                      float def)
```
    Gets the float value at the given index.
    If the index is out of the JSONArray's bounds, no entry set (null), or the value at the index is not a float, the default value will be returned.
    
    Specified by:
    
    getFloat in interface JSONArray
    
    Parameters:
    
    index - The index of the float to retrieve.
    
    def - The default value.
    
    Returns:
    
    The float value at the index.
  - isDouble
```
public boolean isDouble(int index)
```
    Checks if there is a double value at the given index.
    This will return false if the index is out of this JSONArray's bounds, or if there is no entry (null), or if the entry is not a double.
    
    Specified by:
    
    isDouble in interface JSONArray
    
    Parameters:
    
    index - The index to check.
    
    Returns:
    
    true if there is a double at the given index, false otherwise.
  - getDouble
```
public double getDouble(int index)
```
    Gets the double value at the given index.
    If the index is out of the JSONArray's bounds, no entry set (null), or the value at the index is not a double, 0.0D will be returned.
    
    Specified by:
    
    getDouble in interface JSONArray
    
    Parameters:
    
    index - The index of the double to retrieve.
    
    Returns:
    
    The double value at the index.
    
    See Also:
    
    JSONArray.getDouble(int, double)
  - getDouble
```
public double getDouble(int index,
                        double def)
```
    Gets the double value at the given index.
    If the index is out of the JSONArray's bounds, no entry set (null), or the value at the index is not a double, the default value will be returned.
    
    Specified by:
    
    getDouble in interface JSONArray
    
    Parameters:
    
    index - The index of the double to retrieve.
    
    def - The default value.
    
    Returns:
    
    The double value at the index.
  - isString
```
public boolean isString(int index)
```
    Checks if there is a String value at the given index.
    This will return false if the index is out of this JSONArray's bounds, or if there is no entry (null), or if the entry is not a String.
    
    Specified by:
    
    isString in interface JSONArray
    
    Parameters:
    
    index - The index to check.
    
    Returns:
    
    true if there is a String at the given index, false otherwise.
  - getString
```
@Nullable
public @Nullable String getString(int index)
```
    Gets the String value at the given index.
    If the index is out of the JSONArray's bounds, no entry set (null), or the value at the index is not a String, null will be returned.
    
    Specified by:
    
    getString in interface JSONArray
    
    Parameters:
    
    index - The index of the String to retrieve.
    
    Returns:
    
    The String value at the index.
    
    See Also:
    
    JSONArray.getString(int, String)
  - getString
```
@Contract(value="_, !null -> !null")
 @Nullable
public @Nullable String getString(int index,
                                                                                  @Nullable
                                                                                  @Nullable String def)
```
    Gets the String value at the given index.
    If the index is out of the JSONArray's bounds, no entry set (null), or the value at the index is not a String, the default value will be returned.
    
    Specified by:
    
    getString in interface JSONArray
    
    Parameters:
    
    index - The index of the String to retrieve.
    
    def - The default value.
    
    Returns:
    
    The String value at the index.
  - isArray
```
public boolean isArray(int index)
```
    Checks if there is a JSONArray value at the given index.
    This will return false if the index is out of this JSONArray's bounds, or if there is no entry (null), or if the entry is not a JSONArray.
    
    Specified by:
    
    isArray in interface JSONArray
    
    Parameters:
    
    index - The index to check.
    
    Returns:
    
    true if there is a JSONArray at the given index, false otherwise.
  - getArray
```
@Nullable
public @Nullable JSONArray getArray(int index)
```
    Gets the JSONArray value at the given index.
    If the index is out of the JSONArray's bounds, no entry set (null), or the value at the index is not a JSONArray, null will be returned.
    
    Specified by:
    
    getArray in interface JSONArray
    
    Parameters:
    
    index - The index of the JSONArray to retrieve.
    
    Returns:
    
    The JSONArray value at the index.
    
    See Also:
    
    JSONArray.getArray(int, JSONArray)
  - getArray
```
@Contract(value="_, !null -> !null")
 @Nullable
public @Nullable JSONArray getArray(int index,
                                                                                    @Nullable
                                                                                    @Nullable JSONArray def)
```
    Gets the JSONArray value at the given index.
    If the index is out of the JSONArray's bounds, no entry set (null), or the value at the index is not a JSONArray, the default value will be returned.
    
    Specified by:
    
    getArray in interface JSONArray
    
    Parameters:
    
    index - The index of the JSONArray to retrieve.
    
    def - The default value.
    
    Returns:
    
    The JSONArray value at the index.
  - isObject
```
public boolean isObject(int index)
```
    Checks if there is a JSONObject value at the given index.
    This will return false if the index is out of this JSONObject's bounds, or if there is no entry (null), or if the entry is not a JSONObject.
    
    Specified by:
    
    isObject in interface JSONArray
    
    Parameters:
    
    index - The index to check.
    
    Returns:
    
    true if there is a JSONObject at the given index, false otherwise.
  - getObject
```
@Nullable
public @Nullable JSONObject getObject(int index)
```
    Gets the JSONObject value at the given index.
    If the index is out of the JSONObject's bounds, no entry set (null), or the value at the index is not a JSONObject, null will be returned.
    
    Specified by:
    
    getObject in interface JSONArray
    
    Parameters:
    
    index - The index of the JSONObject to retrieve.
    
    Returns:
    
    The JSONObject value at the index.
    
    See Also:
    
    JSONArray.getObject(int, JSONObject)
  - getObject
```
@Contract(value="_, !null -> !null")
 @Nullable
public @Nullable JSONObject getObject(int index,
                                                                                      @Nullable
                                                                                      @Nullable JSONObject def)
```
    Gets the JSONObject value at the given index.
    If the index is out of the JSONObject's bounds, no entry set (null), or the value at the index is not a JSONObject, the default value will be returned.
    
    Specified by:
    
    getObject in interface JSONArray
    
    Parameters:
    
    index - The index of the JSONObject to retrieve.
    
    def - The default value.
    
    Returns:
    
    The JSONObject value at the index.
  - serialize
```
@NotNull
public @NotNull String serialize()
                                   throws JSONException
```
    Serializes this JSONSerializable into a string.
    
    Specified by:
    
    serialize in interface JSONSerializable
    
    Returns:
    
    The serialized JSON data as a String.
    
    Throws:
    
    JSONException - If an error occurs while serializing the data.

Class SimpleJSONArray

Field Summary

Fields inherited from class java.util.AbstractList

Constructor Summary

Method Summary

Methods inherited from class java.util.ArrayList

Methods inherited from class java.util.AbstractList

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Constructor Detail

SimpleJSONArray

SimpleJSONArray

SimpleJSONArray

Method Detail

size

iterator

addEntry

insertEntry

setEntry

unsetEntry

isNull

isBoolean

getBoolean

getBoolean

isByte

getByte

getByte

isShort

getShort

getShort

isInteger

getInteger

getInteger

isLong

getLong

getLong

isFloat

getFloat

getFloat

isDouble

getDouble

getDouble

isString

getString

getString

isArray

getArray

getArray

isObject

getObject

getObject

serialize