kpointer-adapter/com.commonsware.kpointer.adapter/AbstractKpaStructMap

AbstractKpaStructMap

abstract class AbstractKpaStructMap<E>(backingMap: Map<String, E>) : KpaStruct(source)

Convenience base class for KpaStruct implementations backed by a Map with String keys and native values of type E.

Implements get, contains, keys, and toMap by delegating to backingMap and wrapElement. Subclasses must provide factory and wrapElement; everything else is handled here.

This base class is only suitable for adapters whose native map type already uses String keys. Adapters whose native map has non-string keys (e.g. yamlkt's YamlMap keyed by YamlElement) must implement KpaStruct directly.

Parameters

backingMap

The map of string keys to native values to expose.

Type Parameters

The native value element type stored in the backing map.

Constructors

AbstractKpaStructMap

constructor(backingMap: Map<String, E>)

Properties

keys

open override val keys: Set<String>

The set of keys present in backingMap.

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

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

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

open operator override fun get(key: String): KpaElement?

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.

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

open override fun toMap(): Map<String, KpaElement>