runtime-core/io.matthewnelson.kmp.tor.runtime.core/Event

Event

abstract class Event<Data, E : Event<Data, E, O>, O : Event.Observer<Data, E>>(val name: String)(source)

Base abstraction for creating enum like event/observer type hierarchies using kotlin sealed classes & data objects.

e.g.

public sealed class MyEvent private constructor(
    name: String,
): Event(name) {

    public data object THIS: MyEvent("THIS")
    public data object THAT: MyEvent("THAT")

    public open class Observer(
        event: MyEvent,
        tag: String?,
        executor: OnEvent.Executor?,
        onEvent: OnEvent,
    ): Event.Observer(
        event,
        tag,
        executor,
        onEvent
    )

    public companion object: Entries(numEvents = 2) {

        @JvmStatic
        @Throws(IllegalArgumentException::class)
        public override fun valueOf(name: String): MyEvent {
            return super.valueOf(name)
        }

        @JvmStatic
        public override fun valueOfOrNull(name: String): MyEvent? {
            return super.valueOfOrNull(name)
        }

        @JvmStatic
        public override fun entries(): Set {
            return super.entries()
        }

        protected override val lazyEntries: ThisBlock> =
            ThisBlock {
                // NOTE: Update numEvents when adding an event
                add(THIS); add(THAT);
            }
    }

    protected final override fun createProtected(
        event: MyEvent,
        tag: String?,
        executor: OnEvent.Executor?,
        onEvent: OnEvent,
    ): Observer = Observer(event, tag, executor, onEvent)
}