Meta

@Type(id = "meta")

A meta node TODO add documentation Same name siblings are supported via elements with the same Name but different indices.

Types

Companion

common

object Companion

Functions

equals

common

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

getMeta

common

open override fun getMeta(name: Name): Meta?

getValue

common

open override fun getValue(name: Name): Value?

hashCode

common

abstract override fun hashCode(): Int

toMeta

common

open override fun toMeta(): Meta

toString

common

abstract override fun toString(): String

Properties

items

common

abstract val items: Map<NameToken, Meta>

value

common

abstract val value: Value?

Inheritors

TypedMeta

MutableMeta

ObservableMeta

Extensions

asMutableMeta

common

fun Meta.asMutableMeta(): MutableMeta

boolean

common

val Meta?.boolean: Boolean?

copy

common

inline fun Meta.copy(block: MutableMeta.() -> Unit = {}): Meta

Create a copy of this Meta, optionally applying the given block. The listeners of the original Config are not retained.

double

common

val Meta?.double: Double?

enum

common

inline fun <E : Enum<E>> Meta?.enum(): E?

float

common

val Meta?.float: Float?

get

common

operator fun Meta.get(token: NameToken): Meta?

operator fun Meta.get(name: Name): Meta?

Perform recursive item search using given name. Each NameToken is treated as a name in Meta.items of a parent node.

operator fun Meta.get(key: String): Meta?

Parse Name from key using full name notation and pass it to Meta.get

getIndexed

common

fun Meta.getIndexed(name: Name): Map<String?, Meta>

Get all items matching given name. The index of the last element, if present is used as a Regex, against which indexes of elements are matched.

int

common

val Meta?.int: Int?

isEmpty

common

fun Meta.isEmpty(): Boolean

isLeaf

common

val Meta.isLeaf: Boolean

True if this Meta does not have children

iterator

common

operator fun Meta.iterator(): Iterator<Pair<Name, Meta>>

long

common

val Meta?.long: Long?

nodeSequence

common

fun Meta.nodeSequence(): Sequence<Pair<Name, Meta>>

Get a sequence of all Name-TypedMeta pairs in a top-down traversal

number

common

val Meta?.number: Number?

seal

common

fun Meta.seal(): SealedMeta

Generate sealed node from this. If it is already sealed return it as is.

short

common

val Meta?.short: Short?

string

common

val Meta?.string: String?

stringList

common

val Meta.stringList: List<String>?

toDynamic

fun Meta.toDynamic(): dynamic

Represent or copy this Meta to dynamic object to be passed to JS libraries

toJson

common

fun Meta.toJson(descriptor: MetaDescriptor? = null): JsonObject

toMap

common

fun Meta.toMap(descriptor: MetaDescriptor? = null): Map<String, Any?>

Convert meta to map of maps

toMutableMeta

common

fun Meta.toMutableMeta(): ObservableMutableMeta

Create a mutable copy of this meta. The copy is created even if the Meta is already mutable

valueSequence

common

fun Meta.valueSequence(): Sequence<Pair<Name, Value>>

Get a sequence of Name-Value pairs using top-down traversal of the tree

withDefault

common

fun Meta.withDefault(default: Meta?): Meta

Create a provider that uses given provider for default values if those are not found in this provider