couchbase-lite-ee/kotbase/MutableArray

MutableArray

actual class MutableArray : Array, MutableArrayInterface(source)

expect class MutableArray : Array, MutableArrayInterface(source)

Mutable access to array data.

actual class MutableArray : Array, MutableArrayInterface(source)

Constructors

MutableArray

actual constructor()

actual constructor(data: List<Any?>)

actual constructor(json: String)

expect constructor()

Construct a new empty MutableArray.

expect constructor(data: List<Any?>)

Creates a new MutableArray with content from the passed List. Allowed value types are List, Instant, Map, Number, null, String, Array, Blob, and Dictionary. If present, Lists, Arrays, 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

count

actual open override val count: Int

expect open override val count: Int

The number of the items in the array.

actual open override val count: Int

The number of the items in the array.

actual open override val count: Int

Functions

addArray

actual open override fun addArray(value: Array?): MutableArray

expect open override fun addArray(value: Array?): MutableArray

Adds an Array object to the end of the array.

actual open override fun addArray(value: Array?): MutableArray

Adds an Array object to the end of the array.

actual open override fun addArray(value: Array?): MutableArray

addBlob

actual open override fun addBlob(value: Blob?): MutableArray

expect open override fun addBlob(value: Blob?): MutableArray

Adds a Blob object to the end of the array.

actual open override fun addBlob(value: Blob?): MutableArray

Adds a Blob object to the end of the array.

actual open override fun addBlob(value: Blob?): MutableArray

addBoolean

actual open override fun addBoolean(value: Boolean): MutableArray

expect open override fun addBoolean(value: Boolean): MutableArray

Adds a boolean value to the end of the array.

actual open override fun addBoolean(value: Boolean): MutableArray

Adds a boolean value to the end of the array.

actual open override fun addBoolean(value: Boolean): MutableArray

addDate

actual open override fun addDate(value: Instant?): MutableArray

expect open override fun addDate(value: Instant?): MutableArray

Adds an Instant date object to the end of the array.

actual open override fun addDate(value: <Error class: unknown class>?): MutableArray

Adds an Instant date object to the end of the array.

actual open override fun addDate(value: Instant?): MutableArray

addDictionary

actual open override fun addDictionary(value: Dictionary?): MutableArray

expect open override fun addDictionary(value: Dictionary?): MutableArray

Adds a Dictionary object to the end of the array.

actual open override fun addDictionary(value: Dictionary?): MutableArray

Adds a Dictionary object to the end of the array.

actual open override fun addDictionary(value: Dictionary?): MutableArray

addDouble

actual open override fun addDouble(value: Double): MutableArray

expect open override fun addDouble(value: Double): MutableArray

Adds a double value to the end of the array.

actual open override fun addDouble(value: Double): MutableArray

Adds a double value to the end of the array.

actual open override fun addDouble(value: Double): MutableArray

addFloat

actual open override fun addFloat(value: Float): MutableArray

expect open override fun addFloat(value: Float): MutableArray

Adds a float value to the end of the array.

actual open override fun addFloat(value: Float): MutableArray

Adds a float value to the end of the array.

actual open override fun addFloat(value: Float): MutableArray

addInt

actual open override fun addInt(value: Int): MutableArray

expect open override fun addInt(value: Int): MutableArray

Adds an integer value to the end of the array.

actual open override fun addInt(value: Int): MutableArray

Adds an integer value to the end of the array.

actual open override fun addInt(value: Int): MutableArray

addLong

actual open override fun addLong(value: Long): MutableArray

expect open override fun addLong(value: Long): MutableArray

Adds a long value to the end of the array.

actual open override fun addLong(value: Long): MutableArray

Adds a long value to the end of the array.

actual open override fun addLong(value: Long): MutableArray

addNumber

actual open override fun addNumber(value: Number?): MutableArray

expect open override fun addNumber(value: Number?): MutableArray

Adds a Number object to the end of the array.

actual open override fun addNumber(value: Number?): MutableArray

Adds a Number object to the end of the array.

actual open override fun addNumber(value: Number?): MutableArray

addString

actual open override fun addString(value: String?): MutableArray

expect open override fun addString(value: String?): MutableArray

Adds a String object to the end of the array.

actual open override fun addString(value: String?): MutableArray

Adds a String object to the end of the array.

actual open override fun addString(value: String?): MutableArray

addValue

actual open override fun addValue(value: Any?): MutableArray

expect open override fun addValue(value: Any?): MutableArray

Adds an object to the end of the array.

actual open override fun addValue(value: Any?): MutableArray

Adds an object to the end of the array.

actual open override fun addValue(value: Any?): MutableArray

equals

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

get

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

Subscript access to a Fragment object of the projecting result value at the given index.

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

Subscript access to a MutableFragment object of the projecting result value at the given index.

getArray

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

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

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

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

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

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

getBlob

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

expect open override 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 open override 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.

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

getBoolean

actual open override fun getBoolean(index: Int): Boolean

expect open override fun getBoolean(index: Int): Boolean

Gets value at the given index as a boolean.

actual open override fun getBoolean(index: Int): Boolean

Gets value at the given index as a boolean.

actual open override fun getBoolean(index: Int): Boolean

getDate

actual open override fun getDate(index: Int): Instant?

expect open override 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 open override fun getDate(index: Int): Instant?

getDictionary

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

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?

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

actual open override fun getDouble(index: Int): Double

expect open override 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 open override fun getDouble(index: Int): Double

getFloat

actual open override fun getFloat(index: Int): Float

expect open override 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 open override fun getFloat(index: Int): Float

getInt

actual open override fun getInt(index: Int): Int

expect open override 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 open override 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 open override fun getInt(index: Int): Int

getLong

actual open override fun getLong(index: Int): Long

expect open override 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 open override 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 open override fun getLong(index: Int): Long

getNumber

actual open override fun getNumber(index: Int): Number?

expect open override 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 open override 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 open override fun getNumber(index: Int): Number?

getString

actual open override fun getString(index: Int): String?

expect open override 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 open override 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 open override fun getString(index: Int): String?

getValue

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

expect open override 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 null if the value is null.

actual open override 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 null if the value is null.

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

hashCode

open override fun hashCode(): Int

insertArray

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

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

Inserts an Array object at the given index.

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

Inserts an Array object at the given index.

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

insertBlob

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

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

Inserts a Blob object at the given index.

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

Inserts a Blob object at the given index.

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

insertBoolean

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

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

Inserts a boolean value at the given index.

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

Inserts a boolean value at the given index.

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

insertDate

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

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

Inserts an Instant date object at the given index.

actual open override fun insertDate(index: Int, value: <Error class: unknown class>?): MutableArray

Inserts an Instant date object at the given index.

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

insertDictionary

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

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

Inserts a Dictionary object at the given index.

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

Inserts a Dictionary object at the given index.

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

insertDouble

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

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

Inserts a double value at the given index.

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

Inserts a double value at the given index.

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

insertFloat

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

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

Inserts a float value at the given index.

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

Inserts a float value at the given index.

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

insertInt

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

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

Inserts an integer value at the given index.

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

Inserts an integer value at the given index.

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

insertLong

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

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

Inserts a long value at the given index.

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

Inserts a long value at the given index.

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

insertNumber

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

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

Inserts a Number object at the given index.

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

Inserts a Number object at the given index.

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

insertString

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

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

Inserts a String object at the given index.

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

Inserts a String object at the given index.

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

insertValue

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

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

Inserts an object at the given index.

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

Inserts an object at the given index.

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

iterator

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

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

An iterator over elements of this array. A call to the next() method of the returned iterator will throw a ConcurrentModificationException, if the MutableArray is modified while it is in use.

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

remove

actual open override fun remove(index: Int): MutableArray

expect open override fun remove(index: Int): MutableArray

Removes the object at the given index.

actual open override fun remove(index: Int): MutableArray

Removes the object at the given index.

actual open override fun remove(index: Int): MutableArray

setArray

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

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

Sets an Array object at the given index.

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

Sets an Array object at the given index.

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

setBlob

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

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

Sets a Blob object at the given index.

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

Sets a Blob object at the given index.

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

setBoolean

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

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

Sets a boolean value at the given index.

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

Sets a boolean value at the given index.

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

setData

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

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

Populate an array with content from a List. Allowed value types are List, Instant, Map, Number, null, String, Array, Blob, and Dictionary. If present, Lists, Arrays, 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 open override fun setData(data: List<Any?>): MutableArray

setDate

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

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

Sets an Instant date object at the given index.

actual open override fun setDate(index: Int, value: <Error class: unknown class>?): MutableArray

Sets an Instant date object at the given index.

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

setDictionary

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

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

Sets a Dictionary object at the given index.

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

Sets a Dictionary object at the given index.

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

setDouble

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

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

Sets a double value at the given index.

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

Sets a double value at the given index.

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

setFloat

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

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

Sets a float value at the given index.

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

Sets a float value at the given index.

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

setInt

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

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

Sets an integer value at the given index.

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

Sets an integer value at the given index.

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

setJSON

actual open override fun setJSON(json: String): MutableArray

expect open override fun setJSON(json: String): MutableArray

Populate an array with content from a JSON string. Allowed value types are List, Instant, Map, Number, null, String, Array, Blob, and Dictionary. If present, Lists, Arrays, 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 open override fun setJSON(json: String): MutableArray