main.wisp.feature.DynamicConfig.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wisp-feature Show documentation
a module containing feature flag helpers
The newest version!
package wisp.feature

import java.util.concurrent.Executor

/**
 * Interface for evaluating dynamic flags. Dynamic flags are similar to feature flags, but they
 * don't support different variations for different keys.
 */
interface DynamicConfig {
    /**
     * Returns the value of a boolean dynamic flag.
     */
    fun getBoolean(feature: Feature): Boolean

    /**
     * Returns the value of a double dynamic flag.
     */
    fun getDouble(feature: Feature): Double

    /**
     * Returns the value of an integer dynamic flag.
     */
    fun getInt(feature: Feature): Int

    /**
     * Returns the value of a string dynamic flag.
     */
    fun getString(feature: Feature): String

    /**
     * Returns the value of an enumerated dynamic flag.
     */
    fun > getEnum(feature: Feature, clazz: Class): T

    /**
     * Returns the value of a JSON dynamic flag.
     */
    fun  getJson(feature: Feature, clazz: Class): T

    /**
     * Returns the value of a JSON string value of the dynamic flag.
     */
    fun getJsonString(feature: Feature): String

    /**
     * Registers a boolean dynamic config tracker which will be invoked whenever the boolean
     * dynamic config changes value.
     *
     * Returns a tracker reference which can be used to un-register the tracker.
     */
    fun trackBoolean(feature: Feature, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference

    /**
     * Registers a double dynamic config tracker which will be invoked whenever the double
     * dynamic config changes value.
     *
     * Returns a tracker reference which can be used to un-register the tracker.
     */
    fun trackDouble(feature: Feature, executor: Executor, tracker: (Double) -> Unit): TrackerReference

    /**
     * Registers a integer dynamic config tracker which will be invoked whenever the integer
     * dynamic config changes value.
     *
     * Returns a tracker reference which can be used to un-register the tracker.
     */
    fun trackInt(feature: Feature, executor: Executor, tracker: (Int) -> Unit): TrackerReference

    /**
     * Registers a string dynamic config tracker which will be invoked whenever the string
     * dynamic config changes value.
     *
     * Returns a tracker reference which can be used to un-register the tracker.
     */
    fun trackString(feature: Feature, executor: Executor, tracker: (String) -> Unit): TrackerReference

    /**
     * Registers a enum dynamic config tracker which will be invoked whenever the enum
     * dynamic config changes value.
     *
     * Returns a tracker reference which can be used to un-register the tracker.
     */
    fun > trackEnum(
        feature: Feature,
        clazz: Class,
        executor: Executor,
        tracker: (T) -> Unit
    ): TrackerReference

    /**
     * Registers a json dynamic config tracker which will be invoked whenever the json
     * dynamic config changes value.
     *
     * Returns a tracker reference which can be used to un-register the tracker.
     */
    fun  trackJson(feature: Feature, clazz: Class, executor: Executor, tracker: (T) -> Unit): TrackerReference
}

interface TrackerReference {
    fun unregister()
}

inline fun > DynamicConfig.getEnum(
    feature: Feature
): T = getEnum(feature, T::class.java)

inline fun > DynamicConfig.trackEnum(
    feature: Feature,
    executor: Executor,
    noinline tracker: (T) -> Unit
): TrackerReference = trackEnum(feature, T::class.java, executor, tracker)

inline fun  DynamicConfig.getJson(feature: Feature): T = getJson(feature, T::class.java)

inline fun  DynamicConfig.trackJson(
    feature: Feature,
    executor: Executor,
    noinline tracker: (T) -> Unit
): TrackerReference = trackJson(feature, T::class.java, executor, tracker)