ff4k-core/com.yonatankarp.ff4k.core

Package-level declarations

Types

object ContextKeys

Standard keys for FlippingExecutionContext parameters.

@Serializable

data class Feature(val uid: String, val isEnabled: Boolean = false, val description: String? = null, val group: String? = null, val permissions: Set<String> = emptySet(), val flippingStrategy: FlippingStrategy? = null, val customProperties: Map<String, Property<*>> = emptyMap())

Represents a feature flag (feature toggle) identified by a unique identifier.

interface FeatureStore

Storage abstraction for Feature flags with Kotlin-idiomatic operator support.

FlippingExecutionContext

data class FlippingExecutionContext(values: Map<String, Any> = emptyMap()) : CoroutineContext.Element

A type-safe execution context for feature flipping strategies.

FlippingStrategy

fun interface FlippingStrategy

Defines a strategy for determining whether a feature should be enabled.

interface PropertyStore

A store for managing feature flag properties.

Properties

hasFlippingStrategy

val Feature.hasFlippingStrategy: Boolean

Checks if this feature has a flipping strategy configured.

val Feature.hasPermissions: Boolean

Checks if this feature has any permission restrictions.

val Feature.isDisabled: Boolean

Checks if this feature is disabled.

val Feature.propertyNames: Set<String>

Returns the set of all custom property names attached to this feature.

Functions

fun Feature.addGroup(groupName: String): Feature

Returns a new Feature associated with the specified group.

fun Feature.addProperties(vararg properties: Property<*>): Feature

fun Feature.addProperties(properties: Collection<Property<*>>): Feature

Returns a new Feature with multiple properties added.

clearPermissions

fun Feature.clearPermissions(): Feature

Returns a new Feature with all permissions removed.

clearProperties

fun Feature.clearProperties(): Feature

Returns a new Feature with all custom properties removed.

suspend fun PropertyStore.count(): Int

Returns the number of properties in the store.

createOrUpdateProperty

suspend fun <T> PropertyStore.createOrUpdateProperty(property: Property<T>)

Creates a new property or updates it if it already exists (upsert operation).

currentFlippingContext

suspend fun currentFlippingContext(): FlippingExecutionContext

Retrieve the current FlippingExecutionContext from the coroutine context.

inline fun <T> FlippingExecutionContext.getOrThrow(key: String): T

Retrieves a required parameter from the context, throwing if not present.

getPropertiesOfType

inline fun <T> Feature.getPropertiesOfType(): Map<String, Property<T>>

Returns all custom properties whose values are of the specified type.

getPropertyOrThrow

inline fun <T> Feature.getPropertyOrThrow(name: String): Property<T>

Retrieves a custom property by name, throwing an exception if not found.

suspend fun <T> PropertyStore.getPropertyOrThrow(name: String): Property<T>

Retrieves a property by name, throwing an exception if not found.

getPropertyValue

suspend fun <T> PropertyStore.getPropertyValue(name: String): T?

Retrieves a property's value directly, without the Property wrapper.

getPropertyValueOrDefault

inline fun <T> Feature.getPropertyValueOrDefault(name: String, default: T): T

Retrieves a custom property's value by name, returning a default if not found.

suspend fun <T> PropertyStore.getPropertyValueOrDefault(name: String, default: T): T

Retrieves a property's value, or returns a default if not found.

grantPermissions

fun Feature.grantPermissions(vararg permissions: String): Feature

fun Feature.grantPermissions(permissions: Collection<String>): Feature

Returns a new Feature with the specified permissions granted.

hasAllPermissions

fun Feature.hasAllPermissions(vararg permissions: String): Boolean

Checks if this feature has all of the specified permissions.

hasAnyPermission

fun Feature.hasAnyPermission(vararg permissions: String): Boolean

Checks if this feature has at least one of the specified permissions.

hasPropertyWithValue

fun <T> Feature.hasPropertyWithValue(name: String, value: T): Boolean

Checks if a property exists and has a specific value.

fun FlippingExecutionContext.mergeWith(other: FlippingExecutionContext): FlippingExecutionContext

Merges this context with another, with the other context's values taking precedence. Does not modify either original context.

fun Feature.removeGroup(): Feature

Returns a new Feature removed from its current group.

removeProperties

fun Feature.removeProperties(vararg names: String): Feature

fun Feature.removeProperties(names: Collection<String>): Feature

Returns a new Feature with the specified properties removed.

revokePermissions

fun Feature.revokePermissions(vararg permissions: String): Feature

fun Feature.revokePermissions(permissions: Collection<String>): Feature

Returns a new Feature with the specified permissions revoked.

withFlippingContext

inline suspend fun <T> withFlippingContext(context: FlippingExecutionContext, crossinline block: suspend () -> T): T

Execute a block with the given FlippingExecutionContext.

withFlippingParameters

inline suspend fun <T> withFlippingParameters(vararg parameters: Pair<String, Any>, crossinline block: suspend () -> T): T

Execute a block with additional parameters merged into the current context.

fun FlippingExecutionContext.withParameter(key: String, value: Any): FlippingExecutionContext

Creates a new context with an additional parameter. Does not modify the original context.

fun FlippingExecutionContext.withParameters(vararg pairs: Pair<String, Any>): FlippingExecutionContext

Creates a new context with additional parameters. Does not modify the original context.