kpointer-adapter/com.commonsware.kpointer.adapter/RebuildableKpaStruct

RebuildableKpaStruct

interface RebuildableKpaStruct : KpaStruct(source)

A KpaStruct that can reconstruct itself after mutation via a KpaElementFactory.

Read-only adapters implement plain KpaStruct; adapter families that support mutation (e.g. kpointer-kxs, kpointer-yamlkt) implement this interface. The mutate extension is available only on RebuildableKpaStruct receivers, so mutation cannot accidentally be applied to a read-only adapter.

Inheritors

SimpleStruct

Properties

factory

abstract val factory: KpaElementFactory

The factory that knows how to produce primitives and rebuild structs/lists in this adapter family.

keys

abstract val keys: Set<String>

The set of keys present in this struct.

Functions

booleanAt

fun KpaStruct.booleanAt(pointer: KPointer): Boolean?

Returns the boolean value at pointer, or null if the path is absent or the value is not a boolean primitive.

fun KpaStruct.booleanAt(path: String): Boolean?

Parses path via KPointer.from and returns the boolean value at that path, or null if absent or not a boolean.

contains

abstract operator fun contains(key: String): Boolean

Returns whether key is present in this struct.

doubleAt

fun KpaStruct.doubleAt(pointer: KPointer): Double?

Returns the numeric value as Double at pointer, or null if the path is absent or the value is not a numeric primitive.

fun KpaStruct.doubleAt(path: String): Double?

Parses path via KPointer.from and returns the numeric value as Double at that path, or null if absent or not numeric.

get

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

Returns the value associated with key, or null if absent.

get

operator fun KpaStruct.get(pointer: KPointer): KpaElement?

Returns the KpaElement at the path identified by pointer, or null if a key along the path is absent. Returns the receiver if pointer is the root pointer.

listAt

fun KpaStruct.listAt(pointer: KPointer): KpaList?

Returns the KpaList at pointer, or null if the path is absent or the value is not a list.

fun KpaStruct.listAt(path: String): KpaList?

Parses path via KPointer.from and returns the KpaList at that path, or null if absent or not a list.

longAt

fun KpaStruct.longAt(pointer: KPointer): Long?

Returns the numeric value as Long at pointer, or null if the path is absent, the value is not a numeric primitive, or the value has a fractional component.

fun KpaStruct.longAt(path: String): Long?

Parses path via KPointer.from and returns the numeric value as Long at that path, or null if absent, not numeric, or has a fractional component.

mutate

fun RebuildableKpaStruct.mutate(block: KpaStructMutationScope.() -> Unit): RebuildableKpaStruct

Creates a new KpaStruct by applying pointer-based mutations within block.

primitiveAt

fun KpaStruct.primitiveAt(pointer: KPointer): KpaPrimitive?

Returns the KpaPrimitive at pointer, or null if the path is absent or the value is not a primitive.

fun KpaStruct.primitiveAt(path: String): KpaPrimitive?

Parses path via KPointer.from and returns the KpaPrimitive at that path, or null if absent or not a primitive.

requireBacking

inline fun <B : Any> KpaElement.requireBacking(libraryName: String): B

Unwraps this KpaElement to its native backing value of type B, or throws if this element is not a BackedKpaElement whose backing is of type B.

stringAt

fun KpaStruct.stringAt(pointer: KPointer): String?

Returns the string value at pointer, or null if the path is absent or the value is not a string primitive.

fun KpaStruct.stringAt(path: String): String?

Parses path via KPointer.from and returns the string value at that path, or null if absent or not a string.

structAt

fun KpaStruct.structAt(pointer: KPointer): KpaStruct?

Returns the KpaStruct at pointer, or null if the path is absent or the value is not a struct.

fun KpaStruct.structAt(path: String): KpaStruct?

Parses path via KPointer.from and returns the KpaStruct at that path, or null if absent or not a struct.

toMap

abstract fun toMap(): Map<String, KpaElement>

Returns a snapshot of this struct as a plain Map.