couchbase-lite/kotbase/MutableArray

MutableArray

expect class MutableArray : Array(source)

MutableArray provides access to array data.

actual class MutableArray : Array(source)

Constructors

MutableArray

expect constructor()

Constructs a new empty Array object.

expect constructor(data: List<Any?>)

Creates a new MutableArray with content from the passed List. Allowed value types are List, Date, Map, Number, null, String, Array, Blob, and Dictionary. If present, Lists, Maps and Dictionaries may contain only the above types.

expect constructor(json: String)

Creates a new MutableArray with content from the passed JSON string.

actual constructor()

actual constructor(data: List<Any?>)

actual constructor(json: String)

actual constructor()

actual constructor(data: List<Any?>)

actual constructor(json: String)

Properties

actual

open override val actual: FLMutableArray

count

expect val count: Int

The number of the items in the array.

actual val count: Int

Functions

addArray

expect fun addArray(value: Array?): MutableArray

Adds an Array object to the end of the array.

actual fun addArray(value: Array?): MutableArray

addBlob

expect fun addBlob(value: Blob?): MutableArray

Adds a Blob object to the end of the array.

actual fun addBlob(value: Blob?): MutableArray

addBoolean

expect fun addBoolean(value: Boolean): MutableArray

Adds a boolean value to the end of the array.

actual fun addBoolean(value: Boolean): MutableArray

addDate

expect fun addDate(value: Instant?): MutableArray

Adds a Date object to the end of the array.

actual fun addDate(value: Instant?): MutableArray

addDictionary

expect fun addDictionary(value: Dictionary?): MutableArray

Adds a Dictionary object to the end of the array.

actual fun addDictionary(value: Dictionary?): MutableArray

addDouble

expect fun addDouble(value: Double): MutableArray

Adds a double value to the end of the array.

actual fun addDouble(value: Double): MutableArray

addFloat

expect fun addFloat(value: Float): MutableArray

Adds a float value to the end of the array.

actual fun addFloat(value: Float): MutableArray

addInt

expect fun addInt(value: Int): MutableArray

Adds an integer value to the end of the array.

actual fun addInt(value: Int): MutableArray

addLong

expect fun addLong(value: Long): MutableArray

Adds a long value to the end of the array.

actual fun addLong(value: Long): MutableArray

addNumber

expect fun addNumber(value: Number?): MutableArray

Adds a Number object to the end of the array.

actual fun addNumber(value: Number?): MutableArray

addString

expect fun addString(value: String?): MutableArray

Adds a String object to the end of the array.

actual fun addString(value: String?): MutableArray

addValue

expect fun addValue(value: Any?): MutableArray

Adds an object to the end of the array.

actual fun addValue(value: Any?): MutableArray

equals

open operator override fun equals(other: Any?): Boolean

get

operator fun Array.get(index: Int): Fragment

Subscript access to a Fragment object by index.

operator fun MutableArray.get(index: Int): MutableFragment

Subscripting access to a MutableFragment object that represents the value at the given index.

getArray

expect open override fun getArray(index: Int): MutableArray?

Gets an Array at the given index. Return null if the value is not an array.

actual open override fun getArray(index: Int): MutableArray?

getBlob

expect fun getBlob(index: Int): Blob?

Gets value at the given index as a Blob. Returns null if the value doesn't exist, or its value is not a Blob.

actual fun getBlob(index: Int): Blob?

open override fun getBlob(index: Int): Blob?

getBoolean

expect fun getBoolean(index: Int): Boolean

Gets value at the given index as a boolean.

actual fun getBoolean(index: Int): Boolean

getDate

expect fun getDate(index: Int): Instant?

Gets value at the given index as a Date. JSON does not directly support dates, so the actual property value must be a string, which is then parsed according to the ISO-8601 date format (the default used in JSON.) Returns null if the value doesn't exist, is not a string, or is not parsable as a date. NOTE: This is not a generic date parser! It only recognizes the ISO-8601 format, with or without milliseconds.

actual fun getDate(index: Int): Instant?

getDictionary

expect open override fun getDictionary(index: Int): MutableDictionary?

Gets a Dictionary at the given index. Return null if the value is not a dictionary.

actual open override fun getDictionary(index: Int): MutableDictionary?

getDouble

expect fun getDouble(index: Int): Double

Gets value at the given index as a double. Integers will be converted to double. The value true is returned as 1.0, false as 0.0. Returns 0.0 if the property doesn't exist or does not have a numeric value.

actual fun getDouble(index: Int): Double

getFloat

expect fun getFloat(index: Int): Float

Gets value at the given index as a float. Integers will be converted to float. The value true is returned as 1.0, false as 0.0. Returns 0.0 if the value doesn't exist or does not have a numeric value.

actual fun getFloat(index: Int): Float

getInt

expect fun getInt(index: Int): Int

Gets value at the given index as an int. Floating point values will be rounded. The value true is returned as 1, false as 0. Returns 0 if the value doesn't exist or does not have a numeric value.

actual fun getInt(index: Int): Int

getLong

expect fun getLong(index: Int): Long

Gets value at the given index as a long. Floating point values will be rounded. The value true is returned as 1, false as 0. Returns 0 if the value doesn't exist or does not have a numeric value.

actual fun getLong(index: Int): Long

getNumber

expect fun getNumber(index: Int): Number?

Gets value at the given index as a Number. Returns null if the value doesn't exist, or its value is not a Number.

actual fun getNumber(index: Int): Number?

getString

expect fun getString(index: Int): String?

Gets value at the given index as a String. Returns null if the value doesn't exist, or its value is not a String.

actual fun getString(index: Int): String?

getValue

expect fun getValue(index: Int): Any?

Gets value at the given index as an object. The object types are Blob, Array, Dictionary, Number, or String based on the underlying data type; or nil if the value is nil.

actual fun getValue(index: Int): Any?

open override fun getValue(index: Int): Any?

hashCode

open override fun hashCode(): Int

insertArray

expect fun insertArray(index: Int, value: Array?): MutableArray

Inserts an Array object at the given index.

actual fun insertArray(index: Int, value: Array?): MutableArray

insertBlob

expect fun insertBlob(index: Int, value: Blob?): MutableArray

Inserts a Blob object at the given index.

actual fun insertBlob(index: Int, value: Blob?): MutableArray

insertBoolean

expect fun insertBoolean(index: Int, value: Boolean): MutableArray

Inserts a boolean value at the given index.

actual fun insertBoolean(index: Int, value: Boolean): MutableArray

insertDate

expect fun insertDate(index: Int, value: Instant?): MutableArray

Inserts a Date object at the given index.

actual fun insertDate(index: Int, value: Instant?): MutableArray

insertDictionary

expect fun insertDictionary(index: Int, value: Dictionary?): MutableArray

Inserts a Dictionary object at the given index.

actual fun insertDictionary(index: Int, value: Dictionary?): MutableArray

insertDouble

expect fun insertDouble(index: Int, value: Double): MutableArray

Inserts a double value at the given index.

actual fun insertDouble(index: Int, value: Double): MutableArray

insertFloat

expect fun insertFloat(index: Int, value: Float): MutableArray

Inserts a float value at the given index.

actual fun insertFloat(index: Int, value: Float): MutableArray

insertInt

expect fun insertInt(index: Int, value: Int): MutableArray

Inserts an integer value at the given index.

actual fun insertInt(index: Int, value: Int): MutableArray

insertLong

expect fun insertLong(index: Int, value: Long): MutableArray

Inserts a long value at the given index.

actual fun insertLong(index: Int, value: Long): MutableArray

insertNumber

expect fun insertNumber(index: Int, value: Number?): MutableArray

Inserts a Number object at the given index.

actual fun insertNumber(index: Int, value: Number?): MutableArray

insertString

expect fun insertString(index: Int, value: String?): MutableArray

Inserts a String object at the given index.

actual fun insertString(index: Int, value: String?): MutableArray

insertValue

expect fun insertValue(index: Int, value: Any?): MutableArray

Inserts an object at the given index.

actual fun insertValue(index: Int, value: Any?): MutableArray

iterator

expect open operator override fun iterator(): Iterator<Any?>

actual open operator override fun iterator(): Iterator<Any?>

remove

expect fun remove(index: Int): MutableArray

Removes the object at the given index.

actual fun remove(index: Int): MutableArray

setArray

expect fun setArray(index: Int, value: Array?): MutableArray

Sets an Array object at the given index.

actual fun setArray(index: Int, value: Array?): MutableArray

setBlob

expect fun setBlob(index: Int, value: Blob?): MutableArray

Sets a Blob object at the given index.

actual fun setBlob(index: Int, value: Blob?): MutableArray

setBoolean

expect fun setBoolean(index: Int, value: Boolean): MutableArray

Sets a boolean value at the given index.

actual fun setBoolean(index: Int, value: Boolean): MutableArray

setData

expect fun setData(data: List<Any?>): MutableArray

Populate an array with content from a List. Allowed value types are List, Date, Map, Number, null, String, Array, Blob, and Dictionary. If present, Lists, Maps and Dictionaries may contain only the above types. Setting the array content will replace the current data including any existing Array and Dictionary objects.

actual fun setData(data: List<Any?>): MutableArray

setDate

expect fun setDate(index: Int, value: Instant?): MutableArray

Sets a Date object at the given index.

actual fun setDate(index: Int, value: Instant?): MutableArray

setDictionary

expect fun setDictionary(index: Int, value: Dictionary?): MutableArray

Sets a Dictionary object at the given index.

actual fun setDictionary(index: Int, value: Dictionary?): MutableArray

setDouble

expect fun setDouble(index: Int, value: Double): MutableArray

Sets a double value at the given index.

actual fun setDouble(index: Int, value: Double): MutableArray

setFloat

expect fun setFloat(index: Int, value: Float): MutableArray

Sets a float value at the given index.

actual fun setFloat(index: Int, value: Float): MutableArray

setInt

expect fun setInt(index: Int, value: Int): MutableArray

Sets an integer value at the given index.

actual fun setInt(index: Int, value: Int): MutableArray

setJSON

expect fun setJSON(json: String): MutableArray

Populate an array with content from a JSON string. Allowed value types are List, Date, Map, Number, null, String, Array, Blob, and Dictionary. If present, Lists, Maps and Dictionaries may contain only the above types. Setting the array content will replace the current data including any existing Array and Dictionary objects.

actual fun setJSON(json: String): MutableArray