Class MutableArrayObject

A class representing an editable collection of objects

Inheritance
System.Object
ArrayObject
MutableArrayObject
Implements
System.Collections.Generic.IEnumerable<System.Object>
System.Collections.IEnumerable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Couchbase.Lite
Assembly: Couchbase.Lite.dll
Syntax
public sealed class MutableArrayObject : ArrayObject, IJSON, IMutableArray, IArray, IArrayFragment, IEnumerable<object>, IEnumerable, IMutableArrayFragment

Constructors

| Improve this Doc View Source

MutableArrayObject()

Default Constructor

Declaration
public MutableArrayObject()
| Improve this Doc View Source

MutableArrayObject(IList)

Creates an array with the given data

Declaration
public MutableArrayObject(IList array)
Parameters
Type Name Description
System.Collections.IList array

The data to populate the array with
| Improve this Doc View Source

MutableArrayObject(String)

Creates an array with the given json string

Declaration
public MutableArrayObject(string json)
Parameters
Type Name Description
System.String json

The data to populate the array with

Properties

| Improve this Doc View Source

Item[Int32]

Gets a fragment style entry from the array by index

Declaration
public IMutableFragment this[int index] { get; }
Parameters
Type Name Description
System.Int32 index

The index to retrieve
Property Value
Type Description
IMutableFragment

The fragment of the object at the index

Methods

| Improve this Doc View Source

AddArray(ArrayObject)

Adds an entry to this collection

Declaration
public IMutableArray AddArray(ArrayObject value)
Parameters
Type Name Description
ArrayObject value

The value to add
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

AddBlob(Blob)

Adds an entry to this collection

Declaration
public IMutableArray AddBlob(Blob value)
Parameters
Type Name Description
Blob value

The value to add
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

AddBoolean(Boolean)

Adds an entry to this collection

Declaration
public IMutableArray AddBoolean(bool value)
Parameters
Type Name Description
System.Boolean value

The value to add
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

AddDate(DateTimeOffset)

Adds an entry to this collection

Declaration
public IMutableArray AddDate(DateTimeOffset value)
Parameters
Type Name Description
System.DateTimeOffset value

The value to add
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

AddDictionary(DictionaryObject)

Adds an entry to this collection

Declaration
public IMutableArray AddDictionary(DictionaryObject value)
Parameters
Type Name Description
DictionaryObject value

The value to add
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

AddDouble(Double)

Adds an entry to this collection

Declaration
public IMutableArray AddDouble(double value)
Parameters
Type Name Description
System.Double value

The value to add
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

AddFloat(Single)

Adds an entry to this collection

Declaration
public IMutableArray AddFloat(float value)
Parameters
Type Name Description
System.Single value

The value to add
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

AddInt(Int32)

Adds an entry to this collection

Declaration
public IMutableArray AddInt(int value)
Parameters
Type Name Description
System.Int32 value

The value to add
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

AddLong(Int64)

Adds an entry to this collection

Declaration
public IMutableArray AddLong(long value)
Parameters
Type Name Description
System.Int64 value

The value to add
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

AddString(String)

Adds an entry to this collection

Declaration
public IMutableArray AddString(string value)
Parameters
Type Name Description
System.String value

The value to add
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

AddValue(Object)

Adds an entry to this collection

Declaration
public IMutableArray AddValue(object value)
Parameters
Type Name Description
System.Object value

The value to add
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

GetArray(Int32)

Gets the value at the given index as an array

Declaration
public MutableArrayObject GetArray(int index)
Parameters
Type Name Description
System.Int32 index

The index to lookup
Returns
Type Description
MutableArrayObject

The value at the index, or null
| Improve this Doc View Source

GetDictionary(Int32)

Gets the value at the given index as a dictionary

Declaration
public MutableDictionaryObject GetDictionary(int index)
Parameters
Type Name Description
System.Int32 index

The index to lookup
Returns
Type Description
MutableDictionaryObject

The value at the index, or null
| Improve this Doc View Source

InsertArray(Int32, ArrayObject)

Inserts a given value at the given index

Declaration
public IMutableArray InsertArray(int index, ArrayObject value)
Parameters
Type Name Description
System.Int32 index

The index to insert the item at
ArrayObject value

The item to insert
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

InsertBlob(Int32, Blob)

Inserts a given value at the given index

Declaration
public IMutableArray InsertBlob(int index, Blob value)
Parameters
Type Name Description
System.Int32 index

The index to insert the item at
Blob value

The item to insert
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

InsertBoolean(Int32, Boolean)

Inserts a given value at the given index

Declaration
public IMutableArray InsertBoolean(int index, bool value)
Parameters
Type Name Description
System.Int32 index

The index to insert the item at
System.Boolean value

The item to insert
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

InsertDate(Int32, DateTimeOffset)

Inserts a given value at the given index

Declaration
public IMutableArray InsertDate(int index, DateTimeOffset value)
Parameters
Type Name Description
System.Int32 index

The index to insert the item at
System.DateTimeOffset value

The item to insert
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

InsertDictionary(Int32, DictionaryObject)

Inserts a given value at the given index

Declaration
public IMutableArray InsertDictionary(int index, DictionaryObject value)
Parameters
Type Name Description
System.Int32 index

The index to insert the item at
DictionaryObject value

The item to insert
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

InsertDouble(Int32, Double)

Inserts a given value at the given index

Declaration
public IMutableArray InsertDouble(int index, double value)
Parameters
Type Name Description
System.Int32 index

The index to insert the item at
System.Double value

The item to insert
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

InsertFloat(Int32, Single)

Inserts a given value at the given index

Declaration
public IMutableArray InsertFloat(int index, float value)
Parameters
Type Name Description
System.Int32 index

The index to insert the item at
System.Single value

The item to insert
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

InsertInt(Int32, Int32)

Inserts a given value at the given index

Declaration
public IMutableArray InsertInt(int index, int value)
Parameters
Type Name Description
System.Int32 index

The index to insert the item at
System.Int32 value

The item to insert
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

InsertLong(Int32, Int64)

Inserts a given value at the given index

Declaration
public IMutableArray InsertLong(int index, long value)
Parameters
Type Name Description
System.Int32 index

The index to insert the item at
System.Int64 value

The item to insert
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

InsertString(Int32, String)

Inserts a given value at the given index

Declaration
public IMutableArray InsertString(int index, string value)
Parameters
Type Name Description
System.Int32 index

The index to insert the item at
System.String value

The item to insert
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

InsertValue(Int32, Object)

Inserts a given value at the given index

Declaration
public IMutableArray InsertValue(int index, object value)
Parameters
Type Name Description
System.Int32 index

The index to insert the item at
System.Object value

The item to insert
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

RemoveAt(Int32)

Removes the item at the given index

Declaration
public IMutableArray RemoveAt(int index)
Parameters
Type Name Description
System.Int32 index

The index at which to remove the item
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

SetArray(Int32, ArrayObject)

Overwrites the value at the given index with the given value

Declaration
public IMutableArray SetArray(int index, ArrayObject value)
Parameters
Type Name Description
System.Int32 index

The index to overwrite
ArrayObject value

The value to insert
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

SetBlob(Int32, Blob)

Overwrites the value at the given index with the given value

Declaration
public IMutableArray SetBlob(int index, Blob value)
Parameters
Type Name Description
System.Int32 index

The index to overwrite
Blob value

The value to insert
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

SetBoolean(Int32, Boolean)

Overwrites the value at the given index with the given value

Declaration
public IMutableArray SetBoolean(int index, bool value)
Parameters
Type Name Description
System.Int32 index

The index to overwrite
System.Boolean value

The value to insert
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

SetData(IList)

Replaces the contents of this collection with the contents of the given one

Declaration
public IMutableArray SetData(IList array)
Parameters
Type Name Description
System.Collections.IList array

The contents to replace the current contents
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

SetDate(Int32, DateTimeOffset)

Overwrites the value at the given index with the given value

Declaration
public IMutableArray SetDate(int index, DateTimeOffset value)
Parameters
Type Name Description
System.Int32 index

The index to overwrite
System.DateTimeOffset value

The value to insert
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

SetDictionary(Int32, DictionaryObject)

Overwrites the value at the given index with the given value

Declaration
public IMutableArray SetDictionary(int index, DictionaryObject value)
Parameters
Type Name Description
System.Int32 index

The index to overwrite
DictionaryObject value

The value to insert
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

SetDouble(Int32, Double)

Overwrites the value at the given index with the given value

Declaration
public IMutableArray SetDouble(int index, double value)
Parameters
Type Name Description
System.Int32 index

The index to overwrite
System.Double value

The value to insert
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

SetFloat(Int32, Single)

Overwrites the value at the given index with the given value

Declaration
public IMutableArray SetFloat(int index, float value)
Parameters
Type Name Description
System.Int32 index

The index to overwrite
System.Single value

The value to insert
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

SetInt(Int32, Int32)

Overwrites the value at the given index with the given value

Declaration
public IMutableArray SetInt(int index, int value)
Parameters
Type Name Description
System.Int32 index

The index to overwrite
System.Int32 value

The value to insert
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

SetJSON(String)

Replaces the contents of this collection with the contents of the given json string

Declaration
public IMutableArray SetJSON(string json)
Parameters
Type Name Description
System.String json

The json string to replace the current contents with
Returns
Type Description
IMutableArray

The array for further processing
Remarks

json string must be constructed from ToJSON

| Improve this Doc View Source

SetLong(Int32, Int64)

Overwrites the value at the given index with the given value

Declaration
public IMutableArray SetLong(int index, long value)
Parameters
Type Name Description
System.Int32 index

The index to overwrite
System.Int64 value

The value to insert
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

SetString(Int32, String)

Overwrites the value at the given index with the given value

Declaration
public IMutableArray SetString(int index, string value)
Parameters
Type Name Description
System.Int32 index

The index to overwrite
System.String value

The value to insert
Returns
Type Description
IMutableArray

The array for further processing
| Improve this Doc View Source

SetValue(Int32, Object)

Overwrites the value at the given index with the given value

Declaration
public IMutableArray SetValue(int index, object value)
Parameters
Type Name Description
System.Int32 index

The index to overwrite
System.Object value

The value to insert
Returns
Type Description
IMutableArray

The array for further processing

Implements

System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable