couchbase-lite/kotbase/MutableDictionary

MutableDictionary

expect class MutableDictionary : Dictionary(source)

Dictionary provides access to dictionary data.

actual class MutableDictionary : Dictionary(source)

Constructors

MutableDictionary

expect constructor()

Initialize a new empty Dictionary object.

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

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

expect val count: Int

The number of the entries in the dictionary.

actual val count: Int

keys

expect val keys: List<String>

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

actual val keys: List<String>

Functions

contains

expect operator 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 operator fun contains(key: String): Boolean

equals

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

get

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

Subscript access to a Fragment object by key.

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

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

getArray

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

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

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

getBlob

expect 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 fun getBlob(key: String): Blob?

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

getBoolean

expect 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 fun getBoolean(key: String): Boolean

getDate

expect fun getDate(key: String): Instant?

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

getDictionary

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

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

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

getDouble

expect 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 fun getDouble(key: String): Double

getFloat

expect 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 fun getFloat(key: String): Float

getInt

expect 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 fun getInt(key: String): Int

getLong

expect 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 fun getLong(key: String): Long

getNumber

expect 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 fun getNumber(key: String): Number?

getString

expect 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 fun getString(key: String): String?

getValue

expect 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 nil if the property value is null or the property doesn't exist.

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

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

hashCode

open override fun hashCode(): Int

iterator

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

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

remove

expect fun remove(key: String): MutableDictionary

Removes the mapping for a key from this Dictionary

actual fun remove(key: String): MutableDictionary

setArray

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

Set an Array object for the given key.

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

setBlob

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

Set a Blob object for the given key.

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

setBoolean

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

Set a boolean value for the given key.

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

setData

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

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

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

setDate

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

Set a Date object for the given key.

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

setDictionary

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

Set a Dictionary object for the given key.

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

setDouble

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

Set a double value for the given key.

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

setFloat

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

Set a float value for the given key.

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

setInt

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

Set an int value for the given key.

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

setJSON

expect 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 fun setJSON(json: String): MutableDictionary

setLong

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

Set a long value for the given key.

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

setNumber

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

Set a Number value for the given key.

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

setString

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

Set a String value for the given key.

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

setValue

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

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

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

toJSON

expect fun toJSON(): String

actual fun toJSON(): String

open override fun toJSON(): String

toMap

expect fun toMap(): Map<String, Any?>

Gets content of the current object as a Map. The values contained in the returned Map object are all JSON based values.

actual fun toMap(): Map<String, Any?>

toMutable

expect fun toMutable(): MutableDictionary

Return a mutable copy of the dictionary

actual fun toMutable(): MutableDictionary

toString

open override fun toString(): String