IJsonArray (org.spincast:spincast-framework 0.9.28 API)

All Superinterfaces:

Iterable<Object>

All Known Subinterfaces:

IJsonArrayImmutable

All Known Implementing Classes:

JsonArray, JsonArrayImmutable
```
public interface IJsonArray
extends Iterable<Object>
```
Represents a Json array "[]", and makes it easier to get its elements in a typed way.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`IJsonArray`	`add(BigDecimal value)` Adds a BigDecimal.
`IJsonArray`	`add(Boolean value)` Adds a Boolean.
`IJsonArray`	`add(byte[] value)` Adds a byte[].
`IJsonArray`	`add(Date value)` Adds a Date.
`IJsonArray`	`add(Double value)` Adds a Double.
`IJsonArray`	`add(Float value)` Adds a Float.
`IJsonArray`	`add(IJsonArray value)` Adds a IJsonArray.
`IJsonArray`	`add(IJsonArray value, boolean clone)` Adds a IJsonArray.
`IJsonArray`	`add(IJsonObject value)` Adds a IJsonObject.
`IJsonArray`	`add(IJsonObject value, boolean clone)` Adds a IJsonObject.
`IJsonArray`	`add(Integer value)` Adds a Integer.
`IJsonArray`	`add(Long value)` Adds a Long.
`IJsonArray`	`add(String value)` Adds a String.
`IJsonArray`	`addConvert(Object value)` If the object to add is not of a IJsonObject's native type, then the object will be converted to a IJsonObject or a IJsonArray before being added.
`IJsonArray`	`addConvert(Object value, boolean clone)` If the object to add is not of a IJsonObject's native type, then the object will be converted to a IJsonObject or a IJsonArray before being added.
`IJsonArray`	`clear()` Clears all elements.
`IJsonArray`	`clone()` Deep copy of the `IJsonArray`, so any modification to the original won't affect the clone, and vice-versa.
`IJsonArray`	`clone(boolean mutable)` Deep copy of the `IJsonArray`, so any modification to the original won't affect the clone, and vice-versa.
`List<Object>`	`convertToPlainList()` Converts the `IJsonArray` to a plain `List<Object>`.
`List<String>`	`convertToStringList()` Converts the IJsonArray to a `List<String>`.
`BigDecimal`	`getBigDecimal(int index)` Gets an element as `BigDecimal`.
`BigDecimal`	`getBigDecimal(int index, BigDecimal defaultValue)` Gets an element as `BigDecimal`.
`Boolean`	`getBoolean(int index)` Gets an element as `Boolean`.
`Boolean`	`getBoolean(int index, Boolean defaultValue)` Gets an element as `Boolean`.
`byte[]`	`getBytesFromBase64String(int index)` Gets a byte array, from a base 64 encoded property.
`byte[]`	`getBytesFromBase64String(int index, byte[] defaultValue)` Gets a byte array, from a base 64 encoded property.
`Date`	`getDate(int index)` Gets a UTC timezoned date from a `ISO 8601` date property.
`Date`	`getDate(int index, Date defaultValue)` Gets a UTC timezoned date from a `ISO 8601` date property.
`Double`	`getDouble(int index)` Gets an element as `Double`.
`Double`	`getDouble(int index, Double defaultValue)` Gets an element as `Double`.
`Float`	`getFloat(int index)` Gets an element as `Float`.
`Float`	`getFloat(int index, Float defaultValue)` Gets an element as `Float`.
`Integer`	`getInteger(int index)` Gets an element as `Integer`.
`Integer`	`getInteger(int index, Integer defaultValue)` Gets an element as `Integer`.
`IJsonArray`	`getJsonArray(int index)` Gets an element as `IJsonArray`.
`IJsonArray`	`getJsonArray(int index, IJsonArray defaultValue)` Gets an element as `IJsonArray`.
`IJsonArray`	`getJsonArrayOrEmpty(int index)` Gets an element as `IJsonArray`.
`IJsonObject`	`getJsonObject(int index)` Gets an element as `IJsonObject`.
`IJsonObject`	`getJsonObject(int index, IJsonObject defaultValue)` Gets an element as `IJsonObject`.
`IJsonObject`	`getJsonObjectOrEmpty(int index)` Gets an element as `IJsonObject`.
`Long`	`getLong(int index)` Gets an element as `Long`.
`Long`	`getLong(int index, Long defaultValue)` Gets an element as `Long`.
`String`	`getString(int index)` Gets an element as `String`.
`String`	`getString(int index, String defaultValue)` Gets an element as `String`.
`IJsonArray`	`remove(int index)` Removes an element at the specified position.
`int`	`size()` The array size.
`String`	`toJsonString()` The `Json` string representation of the array.
`String`	`toJsonString(boolean pretty)` The `Json` string representation of the array.

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

- Method Detail
  - add
```
IJsonArray add(String value)
```
    Adds a String.
  - add
```
IJsonArray add(Integer value)
```
    Adds a Integer.
  - add
```
IJsonArray add(Long value)
```
    Adds a Long.
  - add
```
IJsonArray add(Float value)
```
    Adds a Float.
  - add
```
IJsonArray add(Double value)
```
    Adds a Double.
  - add
```
IJsonArray add(Boolean value)
```
    Adds a Boolean.
  - add
```
IJsonArray add(BigDecimal value)
```
    Adds a BigDecimal.
  - add
```
IJsonArray add(byte[] value)
```
    Adds a byte[].
  - add
```
IJsonArray add(Date value)
```
    Adds a Date.
  - add
```
IJsonArray add(IJsonObject value)
```
    Adds a IJsonObject. Note that the object is added as is, so any modification to the original object WILL affect the added element, and vice-versa. There is an exception though : if the IJsonObject to add is immutable then it will always be cloned. Doing so, we can make sure a IJsonArray is always fully mutable or fully immutable.
  - add
```
IJsonArray add(IJsonObject value,
               boolean clone)
```
    Adds a IJsonObject.
    
    Parameters:
    
    clone - if true, a clone of the original object will be made before being added. If that case, any modification to the original object won't affect the added element, and vice-versa. If the IJsonObject to add is immutable then it will always be cloned. Doing so, we can make sure a IJsonArray is always fully mutable or fully immutable.
  - add
```
IJsonArray add(IJsonArray value)
```
    Adds a IJsonArray. Note that the object is added as is, so any modification to the original object WILL affect the added element, and vice-versa. There is an exception though : if the IJsonArray to add is immutable then it will always be cloned. Doing so, we can make sure a IJsonArray is always fully mutable or fully immutable.
  - add
```
IJsonArray add(IJsonArray value,
               boolean clone)
```
    Adds a IJsonArray.
    
    Parameters:
    
    clone - if true, a clone of the original object will be made before being added. If that case, any modification to the original IJsonArray won't affect the added element, and vice-versa. If the IJsonArray to add is immutable then it will always be cloned. Doing so, we can make sure a IJsonArray is always fully mutable or fully immutable.
  - addConvert
```
IJsonArray addConvert(Object value)
```
    If the object to add is not of a IJsonObject's native type, then the object will be converted to a IJsonObject or a IJsonArray before being added. Once the object is converted and added, a modification of the original object won't affect the added element, and vice-versa.
    If the element to add is a IJsonObject or a IJsonArray and is immutable then it will be cloned. Doing so, we can make sure a IJsonArray is always fully mutable or fully immutable.
    
    Those are the types of objects that will be converted to a IJsonArray instead of a IJsonObject :
    - A Collection
    - An array
  - addConvert
```
IJsonArray addConvert(Object value,
                      boolean clone)
```
    If the object to add is not of a IJsonObject's native type, then the object will be converted to a IJsonObject or a IJsonArray before being added. Once the object is converted and added, a modification to the original object won't affect the added element, and vice-versa.
    Those are the types of object that will be converted to a IJsonArray instead of a IJsonObject :
    - A Collection
    - An array
    Parameters:
    
    clone - if true, and the element to add is a IJsonObject or IJsonArray, a clone will be made before being added. If that case, any modification to the original element won't affect the added one, and vice-versa. If the element is immutable then it will always be cloned. Doing so, we can make sure a IJsonArray is always fully mutable or fully immutable.
  - remove
```
IJsonArray remove(int index)
```
    Removes an element at the specified position. Any subsequent elements are shift to the left. If the position is invalid, nothing is do.
  - clear
```
IJsonArray clear()
```
    Clears all elements.
  - size
```
int size()
```
    The array size.
  - toJsonString
```
String toJsonString()
```
    The Json string representation of the array.
  - toJsonString
```
String toJsonString(boolean pretty)
```
    The Json string representation of the array.
    
    Parameters:
    
    pretty - if true, the generated String will be formatted.
  - getJsonObject
```
IJsonObject getJsonObject(int index)
```
    Gets an element as IJsonObject.
    
    Returns:
    
    the value of the property or null if not found. Throws an exception if an existing element can't be converted to the required type.
  - getJsonObject
```
IJsonObject getJsonObject(int index,
                          IJsonObject defaultValue)
```
    Gets an element as IJsonObject.
    
    Returns:
    
    the element or the specified defaultValue if not found. Throws an exception if an existing element can't be converted to the required type.
  - getJsonObjectOrEmpty
```
IJsonObject getJsonObjectOrEmpty(int index)
```
    Gets an element as IJsonObject.
    
    Returns:
    
    the element or an empty IJsonObject if not found. Throws an exception if an existing element can't be converted to the required type.
  - getJsonArray
```
IJsonArray getJsonArray(int index)
```
    Gets an element as IJsonArray.
    
    Returns:
    
    the value of the property or null if not found. Throws an exception if an existing element can't be converted to the required type.
  - getJsonArray
```
IJsonArray getJsonArray(int index,
                        IJsonArray defaultValue)
```
    Gets an element as IJsonArray.
    
    Returns:
    
    the element or the specified defaultValue if not found. Throws an exception if an existing element can't be converted to the required type.
  - getJsonArrayOrEmpty
```
IJsonArray getJsonArrayOrEmpty(int index)
```
    Gets an element as IJsonArray.
    
    Returns:
    
    the value of the property or an empty IJsonArray if not found. Throws an exception if an existing element can't be converted to the required type.
  - getString
```
String getString(int index)
```
    Gets an element as String.
    
    Returns:
    
    the value of the property or null if not found. Throws an exception if an existing element can't be converted to the required type.
  - getString
```
String getString(int index,
                 String defaultValue)
```
    Gets an element as String.
    
    Returns:
    
    the value of the property or the specified defaultValue if not found. Throws an exception if an existing element can't be converted to the required type.
  - getInteger
```
Integer getInteger(int index)
```
    Gets an element as Integer.
    
    Returns:
    
    the value of the property or null if not found. Throws an exception if an existing element can't be converted to the required type.
  - getInteger
```
Integer getInteger(int index,
                   Integer defaultValue)
```
    Gets an element as Integer.
    
    Returns:
    
    the value of the property or the specified defaultValue if not found. Throws an exception if an existing element can't be converted to the required type.
  - getLong
```
Long getLong(int index)
```
    Gets an element as Long.
    
    Returns:
    
    the value of the property or null if not found. Throws an exception if an existing element can't be converted to the required type.
  - getLong
```
Long getLong(int index,
             Long defaultValue)
```
    Gets an element as Long.
    
    Returns:
    
    the value of the property or the specified defaultValue if not found. Throws an exception if an existing element can't be converted to the required type.
  - getDouble
```
Double getDouble(int index)
```
    Gets an element as Double.
    
    Returns:
    
    the value of the property or null if not found. Throws an exception if an existing element can't be converted to the required type.
  - getDouble
```
Double getDouble(int index,
                 Double defaultValue)
```
    Gets an element as Double.
    
    Returns:
    
    the value of the property or the specified defaultValue if not found. Throws an exception if an existing element can't be converted to the required type.
  - getFloat
```
Float getFloat(int index)
```
    Gets an element as Float.
    
    Returns:
    
    the value of the property or null if not found. Throws an exception if an existing element can't be converted to the required type.
  - getFloat
```
Float getFloat(int index,
               Float defaultValue)
```
    Gets an element as Float.
    
    Returns:
    
    the value of the property or the specified defaultValue if not found. Throws an exception if an existing element can't be converted to the required type.
  - getBoolean
```
Boolean getBoolean(int index)
```
    Gets an element as Boolean.
    
    Returns:
    
    the value of the property or null if not found. Throws an exception if an existing element can't be converted to the required type.
  - getBoolean
```
Boolean getBoolean(int index,
                   Boolean defaultValue)
```
    Gets an element as Boolean.
    
    Returns:
    
    the value of the property or the specified defaultValue if not found. Throws an exception if an existing element can't be converted to the required type.
  - getBigDecimal
```
BigDecimal getBigDecimal(int index)
```
    Gets an element as BigDecimal.
    
    Returns:
    
    the value of the property or null if not found. Throws an exception if an existing element can't be converted to the required type.
  - getBigDecimal
```
BigDecimal getBigDecimal(int index,
                         BigDecimal defaultValue)
```
    Gets an element as BigDecimal.
    
    Returns:
    
    the value of the property or the specified defaultValue if not found. Throws an exception if an existing element can't be converted to the required type.
  - getBytesFromBase64String
```
byte[] getBytesFromBase64String(int index)
```
    Gets a byte array, from a base 64 encoded property.
    
    Returns:
    
    the value of the property or null if not found. Throws an exception if an existing element can't be converted to the required type.
  - getBytesFromBase64String
```
byte[] getBytesFromBase64String(int index,
                                byte[] defaultValue)
```
    Gets a byte array, from a base 64 encoded property.
    
    Returns:
    
    the value of the property or the specified defaultValue if not found. Throws an exception if an existing element can't be converted to the required type.
  - getDate
```
Date getDate(int index)
```
    Gets a UTC timezoned date from a ISO 8601 date property.
    
    Returns:
    
    the value of the property or null if not found. Throws an exception if an existing element can't be converted to the required type.
  - getDate
```
Date getDate(int index,
             Date defaultValue)
```
    Gets a UTC timezoned date from a ISO 8601 date property.
    
    Returns:
    
    the value of the property or the specified defaultValue if not found. Throws an exception if an existing element can't be converted to the required type.
  - clone
```
IJsonArray clone()
```
    Deep copy of the IJsonArray, so any modification to the original won't affect the clone, and vice-versa.
    The resulting IJsonArray is mutable.
  - clone
```
IJsonArray clone(boolean mutable)
```
    Deep copy of the IJsonArray, so any modification to the original won't affect the clone, and vice-versa.
    
    Parameters:
    
    mutable - if false, the resulting IJsonArray and all its children will be immutable.
  - convertToPlainList
```
List<Object> convertToPlainList()
```
    Converts the IJsonArray to a plain List<Object>. All IJsonObject elements will be converted to Maps and all IJsonArray elements will be converted to Lists.
    This list is always a new instance and is always mutable.
  - convertToStringList
```
List<String> convertToStringList()
```
    Converts the IJsonArray to a List<String>. The toString() method will be called on any non null elements.
    This list is always a new instance and is always mutable.

Interface IJsonArray

Method Summary

Methods inherited from interface java.lang.Iterable

Method Detail

add

add

add

add

add

add

add

add

add

add

add

add

add

addConvert

addConvert

remove

clear

size

toJsonString

toJsonString

getJsonObject

getJsonObject

getJsonObjectOrEmpty

getJsonArray

getJsonArray

getJsonArrayOrEmpty

getString

getString

getInteger

getInteger

getLong

getLong

getDouble

getDouble

getFloat

getFloat

getBoolean

getBoolean

getBigDecimal

getBigDecimal

getBytesFromBase64String

getBytesFromBase64String

getDate

getDate

clone

clone

convertToPlainList

convertToStringList