MutableArray (Couchbase Lite 2.0.0-299)

java.lang.Object
- com.couchbase.lite.Array
- - com.couchbase.lite.MutableArray

All Implemented Interfaces:

Iterable<Object>
```
public final class MutableArray
extends Array
```
MutableArray provides access to array data.

Constructor Summary

Constructors
Constructor and Description

MutableArray()
Constructs a new empty Array object.

MutableArray(List<Object> data)
Constructs a new Array object with an array content.

Constructors
Constructor and Description
`MutableArray()` Constructs a new empty Array object.
`MutableArray(List<Object> data)` Constructs a new Array object with an array content.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`MutableArray`	`addArray(Array value)` Adds an Array object to the end of the array.
`MutableArray`	`addBlob(Blob value)` Adds a Blob object to the end of the array.
`MutableArray`	`addBoolean(boolean value)` Adds a boolean value to the end of the array.
`MutableArray`	`addDate(Date value)` Adds a Date object to the end of the array.
`MutableArray`	`addDictionary(Dictionary value)` Adds a Dictionary object to the end of the array.
`MutableArray`	`addDouble(double value)` Adds a double value to the end of the array.
`MutableArray`	`addFloat(float value)` Adds a float value to the end of the array.
`MutableArray`	`addInt(int value)` Adds an integer value to the end of the array.
`MutableArray`	`addLong(long value)` Adds a long value to the end of the array.
`MutableArray`	`addNumber(Number value)` Adds a Number object to the end of the array.
`MutableArray`	`addString(String value)` Adds a String object to the end of the array.
`MutableArray`	`addValue(Object value)` Adds an object to the end of the array.
`int`	`count()`
`MutableArray`	`getArray(int index)` Gets a Array at the given index.
`Blob`	`getBlob(int index)`
`boolean`	`getBoolean(int index)`
`Date`	`getDate(int index)`
`MutableDictionary`	`getDictionary(int index)` Gets a Dictionary at the given index.
`double`	`getDouble(int index)`
`float`	`getFloat(int index)`
`int`	`getInt(int index)`
`long`	`getLong(int index)`
`Number`	`getNumber(int index)`
`String`	`getString(int index)`
`Object`	`getValue(int index)`
`MutableArray`	`insertArray(int index, Array value)` Inserts an Array object at the given index.
`MutableArray`	`insertBlob(int index, Blob value)` Inserts a Blob object at the given index.
`MutableArray`	`insertBoolean(int index, boolean value)` Inserts a boolean value at the given index.
`MutableArray`	`insertDate(int index, Date value)` Inserts a Date object at the given index.
`MutableArray`	`insertDictionary(int index, Dictionary value)` Inserts a Dictionary object at the given index.
`MutableArray`	`insertDouble(int index, double value)` Inserts a double value at the given index.
`MutableArray`	`insertFloat(int index, float value)` Inserts a float value at the given index.
`MutableArray`	`insertInt(int index, int value)` Inserts an integer value at the given index.
`MutableArray`	`insertLong(int index, long value)` Inserts a long value at the given index.
`MutableArray`	`insertNumber(int index, Number value)` Inserts a Number object at the given index.
`MutableArray`	`insertString(int index, String value)` Inserts a String object at the given index.
`MutableArray`	`insertValue(int index, Object value)` Inserts an object at the given index.
`MutableArray`	`remove(int index)` Removes the object at the given index.
`MutableArray`	`setArray(int index, Array value)` Sets a Array object at the given index.
`MutableArray`	`setBlob(int index, Blob value)` Sets a Blob object at the given index.
`MutableArray`	`setBoolean(int index, boolean value)` Sets a boolean value at the given index.
`MutableArray`	`setData(List<Object> data)` Set an array as a content.
`MutableArray`	`setDate(int index, Date value)` Sets a Date object at the given index.
`MutableArray`	`setDictionary(int index, Dictionary value)` Sets a Dictionary object at the given index.
`MutableArray`	`setDouble(int index, double value)` Sets a double value at the given index.
`MutableArray`	`setFloat(int index, float value)` Sets a float value at the given index.
`MutableArray`	`setInt(int index, int value)` Sets an integer value at the given index.
`MutableArray`	`setLong(int index, long value)` Sets an integer value at the given index.
`MutableArray`	`setNumber(int index, Number value)` Sets an NSNumber object at the given index.
`MutableArray`	`setString(int index, String value)` Sets an String object at the given index.
`MutableArray`	`setValue(int index, Object value)` Set an object at the given index.
`List<Object>`	`toList()`

Methods inherited from class com.couchbase.lite.Array
count, encodeTo, equals, getBlob, getBoolean, getDate, getDouble, getFloat, getInt, getLong, getNumber, getString, getValue, hashCode, iterator, toList, toMutable

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

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

- Constructor Detail
  - MutableArray
```
public MutableArray()
```
    Constructs a new empty Array object.
  - MutableArray
```
public MutableArray(List<Object> data)
```
    Constructs a new Array object with an array content. Allowed value types are List, Date, Map, Number, null, String, Array, Blob, and Dictionary. The List and Map must contain only the above types.
    
    Parameters:
    
    data - the array object.
- Method Detail
  - setData
```
public MutableArray setData(List<Object> data)
```
    Set an array as a content. Allowed value types are List, Date, Map, Number, null, String, Array, Blob, and Dictionary. The List and Map must contain only the above types. Setting the new array content will replcace the current data including the existing Array and Dictionary objects.
    
    Parameters:
    
    data - the array
    
    Returns:
    
    The self object
  - setValue
```
public MutableArray setValue(int index,
                             Object value)
```
    Set an object at the given index.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    value - the object
    
    Returns:
    
    The self object
  - setString
```
public MutableArray setString(int index,
                              String value)
```
    Sets an String object at the given index.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    value - the String object
    
    Returns:
    
    The self object
  - setNumber
```
public MutableArray setNumber(int index,
                              Number value)
```
    Sets an NSNumber object at the given index.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    value - the Number object
    
    Returns:
    
    The self object
  - setInt
```
public MutableArray setInt(int index,
                           int value)
```
    Sets an integer value at the given index.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    value - the int value
    
    Returns:
    
    The self object
  - setLong
```
public MutableArray setLong(int index,
                            long value)
```
    Sets an integer value at the given index.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    value - the long value
    
    Returns:
    
    The self object
  - setFloat
```
public MutableArray setFloat(int index,
                             float value)
```
    Sets a float value at the given index.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    value - the float value
    
    Returns:
    
    The self object
  - setDouble
```
public MutableArray setDouble(int index,
                              double value)
```
    Sets a double value at the given index.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    value - the double value
    
    Returns:
    
    The self object
  - setBoolean
```
public MutableArray setBoolean(int index,
                               boolean value)
```
    Sets a boolean value at the given index.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    value - the boolean value
    
    Returns:
    
    The self object
  - setBlob
```
public MutableArray setBlob(int index,
                            Blob value)
```
    Sets a Blob object at the given index.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    value - the Blob object
    
    Returns:
    
    The self object
  - setDate
```
public MutableArray setDate(int index,
                            Date value)
```
    Sets a Date object at the given index.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    value - the Date object
    
    Returns:
    
    The self object
  - setArray
```
public MutableArray setArray(int index,
                             Array value)
```
    Sets a Array object at the given index.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    value - the Array object
    
    Returns:
    
    The self object
  - setDictionary
```
public MutableArray setDictionary(int index,
                                  Dictionary value)
```
    Sets a Dictionary object at the given index.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    value - the Dictionary object
    
    Returns:
    
    The self object
  - addValue
```
public MutableArray addValue(Object value)
```
    Adds an object to the end of the array.
    
    Parameters:
    
    value - the object
    
    Returns:
    
    The self object
  - addString
```
public MutableArray addString(String value)
```
    Adds a String object to the end of the array.
    
    Parameters:
    
    value - the String object
    
    Returns:
    
    The self object
  - addNumber
```
public MutableArray addNumber(Number value)
```
    Adds a Number object to the end of the array.
    
    Parameters:
    
    value - the Number object
    
    Returns:
    
    The self object
  - addInt
```
public MutableArray addInt(int value)
```
    Adds an integer value to the end of the array.
    
    Parameters:
    
    value - the int value
    
    Returns:
    
    The self object
  - addLong
```
public MutableArray addLong(long value)
```
    Adds a long value to the end of the array.
    
    Parameters:
    
    value - the long value
    
    Returns:
    
    The self object
  - addFloat
```
public MutableArray addFloat(float value)
```
    Adds a float value to the end of the array.
    
    Parameters:
    
    value - the float value
    
    Returns:
    
    The self object
  - addDouble
```
public MutableArray addDouble(double value)
```
    Adds a double value to the end of the array.
    
    Parameters:
    
    value - the double value
    
    Returns:
    
    The self object
  - addBoolean
```
public MutableArray addBoolean(boolean value)
```
    Adds a boolean value to the end of the array.
    
    Parameters:
    
    value - the boolean value
    
    Returns:
    
    The self object
  - addBlob
```
public MutableArray addBlob(Blob value)
```
    Adds a Blob object to the end of the array.
    
    Parameters:
    
    value - the Blob object
    
    Returns:
    
    The self object
  - addDate
```
public MutableArray addDate(Date value)
```
    Adds a Date object to the end of the array.
    
    Parameters:
    
    value - the Date object
    
    Returns:
    
    The self object
  - addArray
```
public MutableArray addArray(Array value)
```
    Adds an Array object to the end of the array.
    
    Parameters:
    
    value - the Array object
    
    Returns:
    
    The self object
  - addDictionary
```
public MutableArray addDictionary(Dictionary value)
```
    Adds a Dictionary object to the end of the array.
    
    Parameters:
    
    value - the Dictonary object
    
    Returns:
    
    The self object
  - insertValue
```
public MutableArray insertValue(int index,
                                Object value)
```
    Inserts an object at the given index.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    value - the object
    
    Returns:
    
    The self object
  - insertString
```
public MutableArray insertString(int index,
                                 String value)
```
    Inserts a String object at the given index.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    value - the String object
    
    Returns:
    
    The self object
  - insertNumber
```
public MutableArray insertNumber(int index,
                                 Number value)
```
    Inserts a Number object at the given index.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    value - the Number object
    
    Returns:
    
    The self object
  - insertInt
```
public MutableArray insertInt(int index,
                              int value)
```
    Inserts an integer value at the given index.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    value - the int value
    
    Returns:
    
    The self object
  - insertLong
```
public MutableArray insertLong(int index,
                               long value)
```
    Inserts a long value at the given index.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    value - the long value
    
    Returns:
    
    The self object
  - insertFloat
```
public MutableArray insertFloat(int index,
                                float value)
```
    Inserts a float value at the given index.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    value - the float value
    
    Returns:
    
    The self object
  - insertDouble
```
public MutableArray insertDouble(int index,
                                 double value)
```
    Inserts a double value at the given index.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    value - the double value
    
    Returns:
    
    The self object
  - insertBoolean
```
public MutableArray insertBoolean(int index,
                                  boolean value)
```
    Inserts a boolean value at the given index.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    value - the boolean value
    
    Returns:
    
    The self object
  - insertBlob
```
public MutableArray insertBlob(int index,
                               Blob value)
```
    Inserts a Blob object at the given index.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    value - the Blob object
    
    Returns:
    
    The self object
  - insertDate
```
public MutableArray insertDate(int index,
                               Date value)
```
    Inserts a Date object at the given index.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    value - the Date object
    
    Returns:
    
    The self object
  - insertArray
```
public MutableArray insertArray(int index,
                                Array value)
```
    Inserts an Array object at the given index.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    value - the Array object
    
    Returns:
    
    The self object
  - insertDictionary
```
public MutableArray insertDictionary(int index,
                                     Dictionary value)
```
    Inserts a Dictionary object at the given index.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    value - the Dictionary object
    
    Returns:
    
    The self object
  - remove
```
public MutableArray remove(int index)
```
    Removes the object at the given index.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    Returns:
    
    The self object
  - getArray
```
public MutableArray getArray(int index)
```
    Gets a Array at the given index. Return null if the value is not an array.
    
    Overrides:
    
    getArray in class Array
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    Returns:
    
    the Array object.
  - getDictionary
```
public MutableDictionary getDictionary(int index)
```
    Gets a Dictionary at the given index. Return null if the value is not an dictionary.
    
    Overrides:
    
    getDictionary in class Array
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    Returns:
    
    the Dictionary object.
  - count
```
public int count()
```
  - getValue
```
public Object getValue(int index)
```
  - getString
```
public String getString(int index)
```
  - getNumber
```
public Number getNumber(int index)
```
  - getInt
```
public int getInt(int index)
```
  - getLong
```
public long getLong(int index)
```
  - getFloat
```
public float getFloat(int index)
```
  - getDouble
```
public double getDouble(int index)
```
  - getBoolean
```
public boolean getBoolean(int index)
```
  - getBlob
```
public Blob getBlob(int index)
```
  - getDate
```
public Date getDate(int index)
```
  - toList
```
public List<Object> toList()
```

Class MutableArray

Constructor Summary

Method Summary

Methods inherited from class com.couchbase.lite.Array

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

MutableArray

MutableArray

Method Detail

setData

setValue

setString

setNumber

setInt

setLong

setFloat

setDouble

setBoolean

setBlob

setDate

setArray

setDictionary

addValue

addString

addNumber

addInt

addLong

addFloat

addDouble

addBoolean

addBlob

addDate

addArray

addDictionary

insertValue

insertString

insertNumber

insertInt

insertLong

insertFloat

insertDouble

insertBoolean

insertBlob

insertDate

insertArray

insertDictionary

remove

getArray

getDictionary

count

getValue

getString

getNumber

getInt

getLong

getFloat

getDouble

getBoolean

getBlob

getDate

toList