core/io.github.kevincianfarini.monarch.core

Package-level declarations

Types

BooleanFeatureFlag

abstract class BooleanFeatureFlag(val key: String, val default: Boolean) : FeatureFlag<Boolean>

A simple Boolean feature flag.

DoubleFeatureFlag

abstract class DoubleFeatureFlag(val key: String, val default: Double) : FeatureFlag<Double>

A simple Double feature flag.

ExperimentalMonarchApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPEALIAS])

annotation class ExperimentalMonarchApi

Marks declarations that are still experimental in Monarch's API, which means that the design of the corresponding declarations has open issues which may (or may not) lead to their changes in the future. Roughly speaking, there is a chance that those declarations will be deprecated in the near future or the semantics of their behavior may change in some way that may break some code.

interface FeatureFlag<OptionType : Any>

A strongly typed representation of a feature flag that couples a key, a default value, and a data type. Feature flag instances can be used to acquire the value that flag represents from a FeatureFlagManager or ObservableFeatureFlagManager implementation.

FeatureFlagDataStore

interface FeatureFlagDataStore

An underlying store of raw, primitive feature flag values.

FeatureFlagManager

interface FeatureFlagManager

Acquire values from FeatureFlag instances.

FeatureFlagManagerMixin

interface FeatureFlagManagerMixin

A supplement to MixinFeatureFlagManager that allows extension via FeatureFlagManagerMixin.currentValueOfOrNull.

InMemoryFeatureFlagDataStoreOverride

@ExperimentalCoroutinesApi

class InMemoryFeatureFlagDataStoreOverride(delegate: ObservableFeatureFlagDataStore) : ObservableFeatureFlagDataStore

An implementation of ObservableFeatureFlagDataStore that allows overriding values produced by delegate with values held in memory.

LongFeatureFlag

abstract class LongFeatureFlag(val key: String, val default: Long) : FeatureFlag<Long>

A simple Long feature flag.

MixinFeatureFlagManager

class MixinFeatureFlagManager(store: FeatureFlagDataStore, mixins: List<FeatureFlagManagerMixin> = emptyList()) : FeatureFlagManager

A FeatureFlagManager implementation that allows extension via mixins.

ObservableFeatureFlagDataStore

interface ObservableFeatureFlagDataStore : FeatureFlagDataStore

An underlying store of raw, primitive feature flag values that supports observability via Flow.

ObservableFeatureFlagManager

interface ObservableFeatureFlagManager : FeatureFlagManager

Acquire a Flow of values from FeatureFlag instances.

ObservableFeatureFlagManagerMixin

interface ObservableFeatureFlagManagerMixin : FeatureFlagManagerMixin

A supplement to ObservableMixinFeatureFlagManager that allows extension via ObservableFeatureFlagManagerMixin.valuesOfOrNull.

ObservableMixinFeatureFlagManager

class ObservableMixinFeatureFlagManager(store: ObservableFeatureFlagDataStore, mixins: List<ObservableFeatureFlagManagerMixin> = emptyList()) : ObservableFeatureFlagManager, FeatureFlagManager

A ObservableFeatureFlagManager implementation that allows extension via mixins.

StringFeatureFlag

abstract class StringFeatureFlag(val key: String, val default: String) : FeatureFlag<String>

A simple String feature flag.