wow-api/me.ahoo.wow.api.query/DynamicDocument

DynamicDocument

interface DynamicDocument : MutableMap<String, Any>

Interface representing a dynamic document that can store arbitrary key-value pairs.

This interface extends MutableMap and provides additional convenience methods for type-safe value retrieval and nested document access. It's designed for working with dynamic data structures where the schema is not known at compile time.

Inheritors

SimpleDynamicDocument

Properties

entries

abstract override val entries: MutableSet<MutableMap.MutableEntry<String, Any>>

keys

abstract override val keys: MutableSet<String>

size

abstract val size: Int

values

abstract override val values: MutableCollection<Any>

Functions

clear

abstract fun clear()

containsKey

abstract fun containsKey(key: String): Boolean

containsValue

abstract fun containsValue(value: Any): Boolean

get

abstract operator fun get(key: String): Any?

getNestedDocument

abstract fun getNestedDocument(key: String): DynamicDocument

Retrieves a nested document from the current document.

getValue

open fun <V> getValue(key: String): V

Retrieves a value from the document with type casting.

isEmpty

abstract fun isEmpty(): Boolean

put

abstract fun put(key: String, value: Any): Any?

putAll

abstract fun putAll(from: Map<out String, Any>)

toDynamicDocument

fun MutableMap<String, Any>.toDynamicDocument(): SimpleDynamicDocument

Extension function to convert a MutableMap to a SimpleDynamicDocument.