couchbase-lite-ee/kotbase/MutableDictionary

MutableDictionary

actual class MutableDictionary : Dictionary, MutableDictionaryInterface(source)

expect class MutableDictionary : Dictionary, MutableDictionaryInterface(source)

Mutable access to dictionary data.

actual class MutableDictionary : Dictionary, MutableDictionaryInterface(source)

Constructors

MutableDictionary

actual constructor()

actual constructor(data: Map<String, Any?>)

actual constructor(json: String)

expect constructor()

Construct a new empty MutableDictionary.

expect constructor(data: Map<String, Any?>)

Creates a new MutableDictionary with content from the passed Map. 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 MutableDictionary with content from the passed JSON string.

actual constructor()

actual constructor(data: Map<String, Any?>)

actual constructor(json: String)

actual constructor()

actual constructor(data: Map<String, Any?>)

actual constructor(json: String)

Properties

count

actual open override val count: Int

expect open override val count: Int

The number of the entries in the dictionary.

actual open override val count: Int

The number of the entries in the dictionary.

actual open override val count: Int

keys

actual open override val keys: List<String>

expect open override val keys: List<String>

A List containing all keys, or an empty List if the dictionary has no properties.

actual open override val keys: List<String>

A List containing all keys, or an empty List if the dictionary has no properties.

actual open override val keys: List<String>

Functions

contains

actual open operator override fun contains(key: String): Boolean

expect open operator override fun contains(key: String): Boolean

Tests whether a property exists or not. This can be less expensive than getValue(String), because it does not have to allocate an Object for the property value.

actual open operator override fun contains(key: String): Boolean

Tests whether a property exists or not. This can be less expensive than getValue(String), because it does not have to allocate an Object for the property value.

actual open operator override fun contains(key: String): Boolean

equals

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

get

operator fun DictionaryInterface.get(key: String): Fragment

Subscript access to a Fragment object of the projecting result value for the given key.

operator fun MutableDictionary.get(key: String): MutableFragment

Subscripting access to a MutableFragment object that represents the value of the dictionary by key.

operator fun MutableDictionaryInterface.get(key: String): MutableFragment

Subscript access to a MutableFragment object of the projecting result value for the given key.

getArray

actual open override fun getArray(key: String): MutableArray?

expect open override fun getArray(key: String): MutableArray?

Get a property's value as an Array. Returns null if the property doesn't exist, or its value is not an array.

actual open override fun getArray(key: String): MutableArray?

Get a property's value as an Array. Returns null if the property doesn't exist, or its value is not an array.

actual open override fun getArray(key: String): MutableArray?

getBlob

actual open override fun getBlob(key: String): Blob?

expect open override fun getBlob(key: String): Blob?

Gets a property's value as a Blob. Returns null if the value doesn't exist, or its value is not a Blob.

actual open override fun getBlob(key: String): Blob?

Gets a property's value as a Blob. Returns null if the value doesn't exist, or its value is not a Blob.

open override fun getBlob(key: String): Blob?

getBoolean

actual open override fun getBoolean(key: String): Boolean

expect open override fun getBoolean(key: String): Boolean

Gets a property's value as a boolean. Returns true if the value exists, and is either true or a nonzero number.

actual open override fun getBoolean(key: String): Boolean

Gets a property's value as a boolean. Returns true if the value exists, and is either true or a nonzero number.

actual open override fun getBoolean(key: String): Boolean

getDate

actual open override fun getDate(key: String): Instant?

expect open override fun getDate(key: String): Instant?

Gets a property's value as an Instant 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(key: String): Instant?

getDictionary

actual open override fun getDictionary(key: String): MutableDictionary?

expect open override fun getDictionary(key: String): MutableDictionary?

Get a property's value as a Dictionary. Returns null if the property doesn't exist, or its value is not a dictionary.

actual open override fun getDictionary(key: String): MutableDictionary?

Get a property's value as a Dictionary. Returns null if the property doesn't exist, or its value is not a dictionary.

actual open override fun getDictionary(key: String): MutableDictionary?

getDouble

actual open override fun getDouble(key: String): Double

expect open override fun getDouble(key: String): Double

Gets a property's value 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(key: String): Double

getFloat

actual open override fun getFloat(key: String): Float

expect open override fun getFloat(key: String): Float

Gets a property's value 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(key: String): Float

Gets a property's value 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(key: String): Float

getInt

actual open override fun getInt(key: String): Int

expect open override fun getInt(key: String): Int

Gets a property's value 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(key: String): Int

Gets a property's value 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(key: String): Int

getLong

actual open override fun getLong(key: String): Long

expect open override fun getLong(key: String): Long

Gets a property's value 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(key: String): Long

Gets a property's value 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(key: String): Long

getNumber

actual open override fun getNumber(key: String): Number?

expect open override fun getNumber(key: String): Number?

Gets a property's value as a Number. Returns null if the value doesn't exist, or its value is not a Number.

actual open override fun getNumber(key: String): Number?

Gets a property's value as a Number. Returns null if the value doesn't exist, or its value is not a Number.

actual open override fun getNumber(key: String): Number?

getString

actual open override fun getString(key: String): String?

expect open override fun getString(key: String): String?

Gets a property's value as a String. Returns null if the value doesn't exist, or its value is not a String.

actual open override fun getString(key: String): String?

Gets a property's value as a String. Returns null if the value doesn't exist, or its value is not a String.

actual open override fun getString(key: String): String?

getValue

actual open override fun getValue(key: String): Any?

expect open override fun getValue(key: String): Any?

Gets a property's value as an object. The object types are Blob, Array, Dictionary, Number, or String based on the underlying data type; or null if the property value is null or the property doesn't exist.

actual open override fun getValue(key: String): Any?

open override fun getValue(key: String): Any?

hashCode

open override fun hashCode(): Int

iterator

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

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

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

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

remove

actual open override fun remove(key: String): MutableDictionary

expect open override fun remove(key: String): MutableDictionary

Removes the mapping for a key from this Dictionary

actual open override fun remove(key: String): MutableDictionary

Removes the mapping for a key from this Dictionary

actual open override fun remove(key: String): MutableDictionary

setArray

actual open override fun setArray(key: String, value: Array?): MutableDictionary

expect open override fun setArray(key: String, value: Array?): MutableDictionary

Set an Array object for the given key.

actual open override fun setArray(key: String, value: Array?): MutableDictionary

Set an Array object for the given key.

actual open override fun setArray(key: String, value: Array?): MutableDictionary

setBlob

actual open override fun setBlob(key: String, value: Blob?): MutableDictionary

expect open override fun setBlob(key: String, value: Blob?): MutableDictionary

Set a Blob object for the given key.

actual open override fun setBlob(key: String, value: Blob?): MutableDictionary

Set a Blob object for the given key.

actual open override fun setBlob(key: String, value: Blob?): MutableDictionary

setBoolean

actual open override fun setBoolean(key: String, value: Boolean): MutableDictionary

expect open override fun setBoolean(key: String, value: Boolean): MutableDictionary

Set a boolean value for the given key.

actual open override fun setBoolean(key: String, value: Boolean): MutableDictionary

Set a boolean value for the given key.

actual open override fun setBoolean(key: String, value: Boolean): MutableDictionary

setData

actual open override fun setData(data: Map<String, Any?>): MutableDictionary

expect open override fun setData(data: Map<String, Any?>): MutableDictionary

Populate a dictionary with content from a Map. 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 dictionary content will replace the current data including any existing Array and Dictionary objects.

actual open override fun setData(data: Map<String, Any?>): MutableDictionary

setDate

actual open override fun setDate(key: String, value: Instant?): MutableDictionary

expect open override fun setDate(key: String, value: Instant?): MutableDictionary

Set an Instant date object for the given key.

actual open override fun setDate(key: String, value: <Error class: unknown class>?): MutableDictionary

Set an Instant date object for the given key.

actual open override fun setDate(key: String, value: Instant?): MutableDictionary

setDictionary

actual open override fun setDictionary(key: String, value: Dictionary?): MutableDictionary

expect open override fun setDictionary(key: String, value: Dictionary?): MutableDictionary

Set a Dictionary object for the given key.

actual open override fun setDictionary(key: String, value: Dictionary?): MutableDictionary

Set a Dictionary object for the given key.

actual open override fun setDictionary(key: String, value: Dictionary?): MutableDictionary

setDouble

actual open override fun setDouble(key: String, value: Double): MutableDictionary

expect open override fun setDouble(key: String, value: Double): MutableDictionary

Set a double value for the given key.

actual open override fun setDouble(key: String, value: Double): MutableDictionary

Set a double value for the given key.

actual open override fun setDouble(key: String, value: Double): MutableDictionary

setFloat

actual open override fun setFloat(key: String, value: Float): MutableDictionary

expect open override fun setFloat(key: String, value: Float): MutableDictionary

Set a float value for the given key.

actual open override fun setFloat(key: String, value: Float): MutableDictionary

Set a float value for the given key.

actual open override fun setFloat(key: String, value: Float): MutableDictionary

setInt

actual open override fun setInt(key: String, value: Int): MutableDictionary

expect open override fun setInt(key: String, value: Int): MutableDictionary

Set an int value for the given key.

actual open override fun setInt(key: String, value: Int): MutableDictionary

Set an int value for the given key.

actual open override fun setInt(key: String, value: Int): MutableDictionary

setJSON

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

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

Populate a dictionary with content from a JSON string. Setting the dictionary content will replace the current data including any existing Array and Dictionary objects.

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

Populate a dictionary with content from a JSON string. Setting the dictionary content will replace the current data including any existing Array and Dictionary objects.

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

setLong

actual open override fun setLong(key: String, value: Long): MutableDictionary

expect open override fun setLong(key: String, value: Long): MutableDictionary

Set a long value for the given key.

actual open override fun setLong(key: String, value: Long): MutableDictionary

Set a long value for the given key.

actual open override fun setLong(key: String, value: Long): MutableDictionary

setNumber

actual open override fun setNumber(key: String, value: Number?): MutableDictionary

expect open override fun setNumber(key: String, value: Number?): MutableDictionary

Set a Number value for the given key.

actual open override fun setNumber(key: String, value: Number?): MutableDictionary

Set a Number value for the given key.

actual open override fun setNumber(key: String, value: Number?): MutableDictionary

setString

actual open override fun setString(key: String, value: String?): MutableDictionary

expect open override fun setString(key: String, value: String?): MutableDictionary

Set a String value for the given key.

actual open override fun setString(key: String, value: String?): MutableDictionary

Set a String value for the given key.

actual open override fun setString(key: String, value: String?): MutableDictionary

setValue

actual open override fun setValue(key: String, value: Any?): MutableDictionary

expect open override fun setValue(key: String, value: Any?): MutableDictionary

Set an object value by key. 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.