com.couchbase.lite

Class MutableArray

java.lang.Object

com.couchbase.lite.Array

com.couchbase.lite.MutableArray

All Implemented Interfaces:

Iterable<Object>

public class MutableArray
extends Array

Array provides access to array data.

Field Summary

Fields inherited from class com.couchbase.lite.Array

_array

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.

Method Summary

Modifier and Type	Method and Description
MutableArray	addArray(MutableArray value)
MutableArray	addBlob(Blob value)
MutableArray	addBoolean(boolean value)
MutableArray	addDate(Date value)
MutableArray	addDictionary(MutableDictionary value)
MutableArray	addDouble(double value)
MutableArray	addFloat(float value)
MutableArray	addInt(int value)
MutableArray	addLong(long value)
MutableArray	addNumber(Number value)
MutableArray	addString(String value)
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, MutableArray value)
MutableArray	insertBlob(int index, Blob value)
MutableArray	insertBoolean(int index, boolean value)
MutableArray	insertDate(int index, Date value)
MutableArray	insertDictionary(int index, MutableDictionary value)
MutableArray	insertDouble(int index, double value)
MutableArray	insertFloat(int index, float value)
MutableArray	insertInt(int index, int value)
MutableArray	insertLong(int index, long value)
MutableArray	insertNumber(int index, Number value)
MutableArray	insertString(int index, String value)
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, MutableArray value)
MutableArray	setBlob(int index, Blob value)
MutableArray	setBoolean(int index, boolean value)
MutableArray	setData(List<Object> data) Set an array as a content.
MutableArray	setDate(int index, Date value)
MutableArray	setDictionary(int index, MutableDictionary value)
MutableArray	setDouble(int index, double value)
MutableArray	setFloat(int index, float value)
MutableArray	setInt(int index, int value)
MutableArray	setLong(int index, long value)
MutableArray	setNumber(int index, Number value)
MutableArray	setString(int index, String value)
MutableArray	setValue(int index, Object value) Set an object at the given index.
List<Object>	toList()

Methods inherited from class com.couchbase.lite.Array

_get, count, encodeTo, equals, getBlob, getBoolean, getDate, getDouble, getFloat, getInt, getLong, getNumber, getString, getValue, hashCode, iterator, outOfBoundsMsg, rangeCheck, toList, toMutable

Methods inherited from class java.lang.Object

clone, finalize, 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:

this Array instance

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:

this Array instance

setString

public MutableArray setString(int index,
                              String value)

setNumber

public MutableArray setNumber(int index,
                              Number value)

setInt

public MutableArray setInt(int index,
                           int value)

setLong

public MutableArray setLong(int index,
                            long value)

setFloat

public MutableArray setFloat(int index,
                             float value)

setDouble

public MutableArray setDouble(int index,
                              double value)

setBoolean

public MutableArray setBoolean(int index,
                               boolean value)

setBlob

public MutableArray setBlob(int index,
                            Blob value)

setDate

public MutableArray setDate(int index,
                            Date value)

setArray

public MutableArray setArray(int index,
                             MutableArray value)

setDictionary

public MutableArray setDictionary(int index,
                                  MutableDictionary value)

addValue

public MutableArray addValue(Object value)

Adds an object to the end of the array.

Parameters:

value - the object

Returns:

this Array instance

addString

public MutableArray addString(String value)

addNumber

public MutableArray addNumber(Number value)

addInt

public MutableArray addInt(int value)

addLong

public MutableArray addLong(long value)

addFloat

public MutableArray addFloat(float value)

addDouble

public MutableArray addDouble(double value)

addBoolean

public MutableArray addBoolean(boolean value)

addBlob

public MutableArray addBlob(Blob value)

addDate

public MutableArray addDate(Date value)

addArray

public MutableArray addArray(MutableArray value)

addDictionary

public MutableArray addDictionary(MutableDictionary value)

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:

this Array instance

insertString

public MutableArray insertString(int index,
                                 String value)

insertNumber

public MutableArray insertNumber(int index,
                                 Number value)

insertInt

public MutableArray insertInt(int index,
                              int value)

insertLong

public MutableArray insertLong(int index,
                               long value)

insertFloat

public MutableArray insertFloat(int index,
                                float value)

insertDouble

public MutableArray insertDouble(int index,
                                 double value)

insertBoolean

public MutableArray insertBoolean(int index,
                                  boolean value)

insertBlob

public MutableArray insertBlob(int index,
                               Blob value)

insertDate

public MutableArray insertDate(int index,
                               Date value)

insertArray

public MutableArray insertArray(int index,
                                MutableArray value)

insertDictionary

public MutableArray insertDictionary(int index,
                                     MutableDictionary value)

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:

this Array instance

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