nova-registry/xyz.xenondevs.nova.registry/RegistryEntrySet/Nova/Tag

Tag

sealed interface Tag<out T : NovaRegistryElement<T>> : RegistryEntrySet.Nova<T>

A RegistryEntrySet.Nova backed by a tag.

Properties

abstract val children: Set<Provider<*>>

open val delegate: Provider<Set<T>>

abstract val entries: Provider<Set<RegistryEntry.Nova<T>>>

The entries contained in this RegistryEntrySet.Nova.Tag.

abstract val isStable: Boolean

abstract val parents: Set<Provider<*>>

abstract val registry: NovaRegistry<T>

The registry this RegistryEntrySet.Nova belongs to.

abstract val tagKey: Key

The key of the tag this RegistryEntrySet.Nova.Tag is backed by.

abstract val value: DeferredValue<Set<T>>

Functions

abstract fun addStrongChild(child: Provider<*>)

abstract fun addWeakChild(child: Provider<*>)

bootstrapFlatMap

fun <T, R> Provider<T>.bootstrapFlatMap(transform: (T) -> Provider<R>): Provider<R>

Flat-maps the value of this provider via transform. During bootstrap phase, uses Provider.flatMap, otherwise Provider.immediateFlatMap. This allows creating flat-mapped providers based off of RegistryEntries lazily during bootstrap phase, where resolving their value is not possible, without paying for the extra overhead post-bootstrap, where immediateFlatMap can be used.

bootstrapFlatten

fun <T> Provider<Provider<T>>.bootstrapFlatten(): Provider<T>

Flattens the value of this provider. During bootstrap phase, uses Provider.flatMap, otherwise Provider.immediateFlatMap. This allows creating flat-mapped providers based off of RegistryEntries lazily during bootstrap phase, where resolving their value is not possible, without paying for the extra overhead post-bootstrap, where immediateFlatMap can be used.

open operator fun contains(value: T): Boolean

Checks whether value is part of this set. Requires resolving this set and as such this function may not be called before registry freeze.

abstract operator override fun contains(entry: RegistryEntry.Nova<T>?): Boolean

Checks whether entry is part of this set. Requires resolving the corresponding tag and cannot be called before registry freeze. Also note that tag contents can change at any time.

abstract fun <R> flatMap(transform: (Set<T>) -> Provider<R>): Provider<R>

open override fun get(): Set<T>

open operator fun <X> getValue(thisRef: X?, property: KProperty<*>?): Set<T>

handleParentUpdated

abstract fun handleParentUpdated(updatedParent: Provider<*>)

immediateFlatMap

abstract fun <R> immediateFlatMap(transform: (Set<T>) -> Provider<R>): Provider<R>

immediateFlatMapMutable

abstract fun <R> immediateFlatMapMutable(transform: (Set<T>) -> MutableProvider<R>): MutableProvider<R>

abstract fun <R> map(transform: (Set<T>) -> R): Provider<R>

abstract fun observe(action: () -> Unit)

abstract fun <R : Any> observeWeak(owner: R, action: (owner: R) -> Unit)

removeStrongChild

abstract fun removeStrongChild(child: Provider<*>)

removeWeakChild

abstract fun removeWeakChild(child: Provider<*>)

abstract fun <R> strongFlatMap(transform: (Set<T>) -> Provider<R>): Provider<R>

strongImmediateFlatMap

abstract fun <R> strongImmediateFlatMap(transform: (Set<T>) -> Provider<R>): Provider<R>

strongImmediateFlatMapMutable

abstract fun <R> strongImmediateFlatMapMutable(transform: (Set<T>) -> MutableProvider<R>): MutableProvider<R>

abstract fun <R> strongMap(transform: (Set<T>) -> R): Provider<R>

abstract fun subscribe(action: (value: Set<T>) -> Unit)

abstract fun <R : Any> subscribeWeak(owner: R, action: (owner: R, value: Set<T>) -> Unit)

abstract fun unobserve(action: () -> Unit)

abstract fun <R : Any> unobserveWeak(owner: R)

abstract fun <R : Any> unobserveWeak(owner: R, action: (R) -> Unit)

abstract fun unsubscribe(action: (Set<T>) -> Unit)

unsubscribeWeak

abstract fun <R : Any> unsubscribeWeak(owner: R)

abstract fun <R : Any> unsubscribeWeak(owner: R, action: (R, Set<T>) -> Unit)