kotlin-odata/com.sap.cloud.mobile.kotlin.odata/ComplexValueMap

ComplexValueMap

open class ComplexValueMap : MapBase

A map from key type string to value type {@link com.sap.cloud.mobile.kotlin.odata.ComplexValue}.

Constructors

ComplexValueMap

constructor()

See ComplexValueMap(Int).

constructor(capacity: Int)

Construct a new map with {@link com.sap.cloud.mobile.kotlin.odata.ComplexValueMap#size ComplexValueMap.size} of zero and optional initial capacity. A map can expand in size beyond its initial capacity, but best performance will be obtained if the initial capacity is close to (and not less than) the map's maximum size.

Types

object Companion

open class Entry

A key/value pair for map entries.

open class EntryList : ListBase, Iterable<ComplexValueMap.Entry>

A list of item type {@link com.sap.cloud.mobile.kotlin.odata.ComplexValueMap.Entry}.

Properties

open override val untypedMap: UntypedMap

Functions

open fun copy(): ComplexValueMap

Return a shallow copy of this map.

open fun delete(key: String): Boolean

For internal use only.

open fun entries(): ComplexValueMap.EntryList

Return a list of the entries (key/value pairs) in this map.

open fun get(key: String): ComplexValue?

Return (nullable) The value from the entry with the specified key (if found), otherwise null.

open fun getRequired(key: String): ComplexValue

Return the value from the entry with the specified key (if found).

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.MissingEntryException} (fatal) if no entry is found for the specified key.

open fun has(key: String): Boolean

Return true if this map has an entry with the specified key, otherwise false.

open fun keys(): StringList

Return a list of the entry keys in this map.

open fun merge(from: ComplexValueMap)

Merge all the entries of from to this map, replacing any entry for which the key already exists in this map.

open fun remove(key: String): Boolean

Remove the entry with the specified key (if found).

open fun set(key: String, value: ComplexValue)

Add or replace an entry with the specified key and value.

open fun setThis(key: String, value: ComplexValue): ComplexValueMap

Add or replace an entry with the specified key and value.

open fun sortedEntries(): ComplexValueMap.EntryList

Return a sorted list of the entries in this map, using the ordering of this.keys().

open fun sortedKeys(): StringList

Return a sorted list of the keys in this map.

open fun sortedValues(): ComplexValueList

Return a sorted list of the values in this map.

open fun values(): ComplexValueList

Return a list of the entry values in this map.