A B C D E F G H I K L M N O P R S T U V W

A

accept(T, U, V) - Method in interface dev.openfeature.sdk.internal.TriConsumer

Performs this operation on the given arguments.

add(String, Boolean) - Method in class dev.openfeature.sdk.MutableContext

add(String, String) - Method in class dev.openfeature.sdk.MutableContext

add(String, Integer) - Method in class dev.openfeature.sdk.MutableContext

add(String, Double) - Method in class dev.openfeature.sdk.MutableContext

add(String, Instant) - Method in class dev.openfeature.sdk.MutableContext

add(String, Structure) - Method in class dev.openfeature.sdk.MutableContext

add(String, List<Value>) - Method in class dev.openfeature.sdk.MutableContext

add(String, Value) - Method in class dev.openfeature.sdk.MutableStructure

add(String, Boolean) - Method in class dev.openfeature.sdk.MutableStructure

add(String, String) - Method in class dev.openfeature.sdk.MutableStructure

add(String, Integer) - Method in class dev.openfeature.sdk.MutableStructure

add(String, Double) - Method in class dev.openfeature.sdk.MutableStructure

add(String, Instant) - Method in class dev.openfeature.sdk.MutableStructure

add(String, Structure) - Method in class dev.openfeature.sdk.MutableStructure

add(String, List<Value>) - Method in class dev.openfeature.sdk.MutableStructure

addBoolean(String, Boolean) - Method in class dev.openfeature.sdk.ImmutableMetadata.ImmutableMetadataBuilder

Add Boolean value to the metadata.

addDouble(String, Double) - Method in class dev.openfeature.sdk.ImmutableMetadata.ImmutableMetadataBuilder

Add Double value to the metadata.

addFloat(String, Float) - Method in class dev.openfeature.sdk.ImmutableMetadata.ImmutableMetadataBuilder

Add Float value to the metadata.

addHooks(Hook...) - Method in interface dev.openfeature.sdk.Client

Adds hooks for evaluation.

addHooks(Hook...) - Method in class dev.openfeature.sdk.OpenFeatureAPI

Adds hooks for globally, used for all evaluations.

addHooks(Hook...) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

Adds hooks for evaluation.

addInteger(String, Integer) - Method in class dev.openfeature.sdk.ImmutableMetadata.ImmutableMetadataBuilder

Add Integer value to the metadata.

addLong(String, Long) - Method in class dev.openfeature.sdk.ImmutableMetadata.ImmutableMetadataBuilder

Add Long value to the metadata.

addString(String, String) - Method in class dev.openfeature.sdk.ImmutableMetadata.ImmutableMetadataBuilder

Add String value to the metadata.

after(HookContext<T>, FlagEvaluationDetails<T>, Map<String, Object>) - Method in interface dev.openfeature.sdk.Hook

Runs after a flag is resolved.

after(HookContext<Object>, FlagEvaluationDetails<Object>, Map<String, Object>) - Method in class dev.openfeature.sdk.hooks.logging.LoggingHook

andThen(TriConsumer<T, U, V>) - Method in interface dev.openfeature.sdk.internal.TriConsumer

Returns a composed TriConsumer that performs an additional operation.

asBoolean() - Method in class dev.openfeature.sdk.Value

Retrieve the underlying Boolean value, or null.

asDouble() - Method in class dev.openfeature.sdk.Value

Retrieve the underlying numeric value as a Double, or null.

asInstant() - Method in class dev.openfeature.sdk.Value

Retrieve the underlying Instant value, or null.

asInteger() - Method in class dev.openfeature.sdk.Value

Retrieve the underlying numeric value as an Integer, or null.

asList() - Method in class dev.openfeature.sdk.Value

Retrieve the underlying List value, or null.

asMap() - Method in class dev.openfeature.sdk.ImmutableStructure

Get all values.

asMap() - Method in class dev.openfeature.sdk.MutableStructure

Get all values.

asMap() - Method in interface dev.openfeature.sdk.Structure

Get all values, as a map of Values.

asObject() - Method in class dev.openfeature.sdk.Value

Retrieve the underlying object.

asObjectMap() - Method in interface dev.openfeature.sdk.Structure

Get all values, with as a map of Object.

asString() - Method in class dev.openfeature.sdk.Value

Retrieve the underlying String value, or null.

asStructure() - Method in class dev.openfeature.sdk.Value

Retrieve the underlying Structure value, or null.

AutoCloseableLock - Interface in dev.openfeature.sdk.internal

AutoCloseableReentrantReadWriteLock - Class in dev.openfeature.sdk.internal

A utility class that wraps a multi-read/single-write lock construct as AutoCloseable, so it can be used in a try-with-resources.

AutoCloseableReentrantReadWriteLock() - Constructor for class dev.openfeature.sdk.internal.AutoCloseableReentrantReadWriteLock

B

BaseEvaluation<T> - Interface in dev.openfeature.sdk

This is a common interface between the evaluation results that providers return and what is given to the end users.

before(HookContext<T>, Map<String, Object>) - Method in interface dev.openfeature.sdk.Hook

Runs before flag is resolved.

before(HookContext<Object>, Map<String, Object>) - Method in class dev.openfeature.sdk.hooks.logging.LoggingHook

BooleanHook - Interface in dev.openfeature.sdk

An extension point which can run around flag resolution.

build() - Method in class dev.openfeature.sdk.ImmutableMetadata.ImmutableMetadataBuilder

Retrieve ImmutableMetadata with provided key,value pairs.

builder() - Static method in class dev.openfeature.sdk.ImmutableMetadata

Obtain a builder for ImmutableMetadata.

C

clearHooks() - Method in class dev.openfeature.sdk.OpenFeatureAPI

Removes all hooks.

Client - Interface in dev.openfeature.sdk

Interface used to resolve flags of varying types.

ClientMetadata - Interface in dev.openfeature.sdk

Metadata specific to an OpenFeature Client.

clone() - Method in class dev.openfeature.sdk.Value

Perform deep clone of value object.

close() - Method in interface dev.openfeature.sdk.internal.AutoCloseableLock

Override the exception in AutoClosable.

ContextEvaluator<T> - Interface in dev.openfeature.sdk.providers.memory

Context evaluator - use for resolving flag according to evaluation context, for handling targeting.

convertValue(Value) - Method in interface dev.openfeature.sdk.Structure

Converts the Value into its equivalent primitive type.

D

defaultIfNull(List<T>, Supplier<List<T>>) - Static method in class dev.openfeature.sdk.internal.ObjectUtils

If the source param is null, return the default value.

defaultIfNull(Map<K, V>, Supplier<Map<K, V>>) - Static method in class dev.openfeature.sdk.internal.ObjectUtils

If the source param is null, return the default value.

defaultIfNull(T, Supplier<T>) - Static method in class dev.openfeature.sdk.internal.ObjectUtils

If the source param is null, return the default value.

dev.openfeature.sdk - package dev.openfeature.sdk

dev.openfeature.sdk.exceptions - package dev.openfeature.sdk.exceptions

dev.openfeature.sdk.hooks.logging - package dev.openfeature.sdk.hooks.logging

dev.openfeature.sdk.internal - package dev.openfeature.sdk.internal

dev.openfeature.sdk.providers.memory - package dev.openfeature.sdk.providers.memory

DoubleHook - Interface in dev.openfeature.sdk

An extension point which can run around flag resolution.

E

emit(ProviderEvent, ProviderEventDetails) - Method in class dev.openfeature.sdk.EventProvider

Emit the specified ProviderEvent.

emitProviderConfigurationChanged(ProviderEventDetails) - Method in class dev.openfeature.sdk.EventProvider

Emit a ProviderEvent.PROVIDER_CONFIGURATION_CHANGED event.

emitProviderError(ProviderEventDetails) - Method in class dev.openfeature.sdk.EventProvider

Emit a ProviderEvent.PROVIDER_ERROR event.

emitProviderReady(ProviderEventDetails) - Method in class dev.openfeature.sdk.EventProvider

Emit a ProviderEvent.PROVIDER_READY event.

emitProviderStale(ProviderEventDetails) - Method in class dev.openfeature.sdk.EventProvider

Emit a ProviderEvent.PROVIDER_STALE event.

error(HookContext<T>, Exception, Map<String, Object>) - Method in interface dev.openfeature.sdk.Hook

Run when evaluation encounters an error.

error(HookContext<Object>, Exception, Map<String, Object>) - Method in class dev.openfeature.sdk.hooks.logging.LoggingHook

ErrorCode - Enum in dev.openfeature.sdk

evaluate(Flag, EvaluationContext) - Method in interface dev.openfeature.sdk.providers.memory.ContextEvaluator

EvaluationContext - Interface in dev.openfeature.sdk

The EvaluationContext is a container for arbitrary contextual data that can be used as a basis for dynamic evaluation.

EventBus<T> - Interface in dev.openfeature.sdk

Interface for attaching event handlers.

EventDetails - Class in dev.openfeature.sdk

The details of a particular event.

EventDetails() - Constructor for class dev.openfeature.sdk.EventDetails

EventProvider - Class in dev.openfeature.sdk

Abstract EventProvider.

EventProvider() - Constructor for class dev.openfeature.sdk.EventProvider

ExceptionUtils - Class in dev.openfeature.sdk.exceptions

ExceptionUtils() - Constructor for class dev.openfeature.sdk.exceptions.ExceptionUtils

ExcludeFromGeneratedCoverageReport - Annotation Type in dev.openfeature.sdk.internal

JaCoCo ignores coverage of methods annotated with any annotation with "generated" in the name.

F

FeatureProvider - Interface in dev.openfeature.sdk

The interface implemented by upstream flag providers to resolve flags for their service.

Features - Interface in dev.openfeature.sdk

An API for the type-specific fetch methods offered to users.

fillInStackTrace() - Method in exception dev.openfeature.sdk.exceptions.FlagNotFoundError

finalize() - Method in class dev.openfeature.sdk.Value

finallyAfter(HookContext<T>, Map<String, Object>) - Method in interface dev.openfeature.sdk.Hook

Run after flag evaluation, including any error processing.

Flag<T> - Class in dev.openfeature.sdk.providers.memory

Flag representation for the in-memory provider.

Flag() - Constructor for class dev.openfeature.sdk.providers.memory.Flag

FlagEvaluationDetails<T> - Class in dev.openfeature.sdk

Contains information about how the provider resolved a flag, including the resolved value.

FlagEvaluationDetails() - Constructor for class dev.openfeature.sdk.FlagEvaluationDetails

FlagEvaluationOptions - Class in dev.openfeature.sdk

FlagEvaluationOptions() - Constructor for class dev.openfeature.sdk.FlagEvaluationOptions

FlagNotFoundError - Exception in dev.openfeature.sdk.exceptions

FlagNotFoundError() - Constructor for exception dev.openfeature.sdk.exceptions.FlagNotFoundError

FlagValueType - Enum in dev.openfeature.sdk

from(ProviderEvaluation<T>, String) - Static method in class dev.openfeature.sdk.FlagEvaluationDetails

Generate detail payload from the provider response.

from(String, FlagValueType, ClientMetadata, Metadata, EvaluationContext, T) - Static method in class dev.openfeature.sdk.HookContext

Builds a HookContext instances from request data.

G

GeneralError - Exception in dev.openfeature.sdk.exceptions

GeneralError() - Constructor for exception dev.openfeature.sdk.exceptions.GeneralError

getBoolean(String) - Method in class dev.openfeature.sdk.ImmutableMetadata

Retrieve a Boolean value for the given key.

getBooleanDetails(String, Boolean) - Method in interface dev.openfeature.sdk.Features

getBooleanDetails(String, Boolean, EvaluationContext) - Method in interface dev.openfeature.sdk.Features

getBooleanDetails(String, Boolean, EvaluationContext, FlagEvaluationOptions) - Method in interface dev.openfeature.sdk.Features

getBooleanDetails(String, Boolean) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getBooleanDetails(String, Boolean, EvaluationContext) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getBooleanDetails(String, Boolean, EvaluationContext, FlagEvaluationOptions) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getBooleanEvaluation(String, Boolean, EvaluationContext) - Method in interface dev.openfeature.sdk.FeatureProvider

getBooleanEvaluation(String, Boolean, EvaluationContext) - Method in class dev.openfeature.sdk.NoOpProvider

getBooleanEvaluation(String, Boolean, EvaluationContext) - Method in class dev.openfeature.sdk.providers.memory.InMemoryProvider

getBooleanValue(String, Boolean) - Method in interface dev.openfeature.sdk.Features

getBooleanValue(String, Boolean, EvaluationContext) - Method in interface dev.openfeature.sdk.Features

getBooleanValue(String, Boolean, EvaluationContext, FlagEvaluationOptions) - Method in interface dev.openfeature.sdk.Features

getBooleanValue(String, Boolean) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getBooleanValue(String, Boolean, EvaluationContext) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getBooleanValue(String, Boolean, EvaluationContext, FlagEvaluationOptions) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getClient() - Method in class dev.openfeature.sdk.OpenFeatureAPI

A factory function for creating new, OpenFeature clients.

getClient(String) - Method in class dev.openfeature.sdk.OpenFeatureAPI

A factory function for creating new domainless OpenFeature clients.

getClient(String, String) - Method in class dev.openfeature.sdk.OpenFeatureAPI

A factory function for creating new domainless OpenFeature clients.

getDomain() - Method in interface dev.openfeature.sdk.ClientMetadata

getDouble(String) - Method in class dev.openfeature.sdk.ImmutableMetadata

Retrieve a Double value for the given key.

getDoubleDetails(String, Double) - Method in interface dev.openfeature.sdk.Features

getDoubleDetails(String, Double, EvaluationContext) - Method in interface dev.openfeature.sdk.Features

getDoubleDetails(String, Double, EvaluationContext, FlagEvaluationOptions) - Method in interface dev.openfeature.sdk.Features

getDoubleDetails(String, Double) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getDoubleDetails(String, Double, EvaluationContext) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getDoubleDetails(String, Double, EvaluationContext, FlagEvaluationOptions) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getDoubleEvaluation(String, Double, EvaluationContext) - Method in interface dev.openfeature.sdk.FeatureProvider

getDoubleEvaluation(String, Double, EvaluationContext) - Method in class dev.openfeature.sdk.NoOpProvider

getDoubleEvaluation(String, Double, EvaluationContext) - Method in class dev.openfeature.sdk.providers.memory.InMemoryProvider

getDoubleValue(String, Double) - Method in interface dev.openfeature.sdk.Features

getDoubleValue(String, Double, EvaluationContext) - Method in interface dev.openfeature.sdk.Features

getDoubleValue(String, Double, EvaluationContext, FlagEvaluationOptions) - Method in interface dev.openfeature.sdk.Features

getDoubleValue(String, Double) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getDoubleValue(String, Double, EvaluationContext) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getDoubleValue(String, Double, EvaluationContext, FlagEvaluationOptions) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getErrorCode() - Method in interface dev.openfeature.sdk.BaseEvaluation

The error code, if applicable.

getErrorCode() - Method in exception dev.openfeature.sdk.exceptions.OpenFeatureError

getErrorMessage() - Method in interface dev.openfeature.sdk.BaseEvaluation

The error message (usually from exception.getMessage()), if applicable.

getEvaluationContext() - Method in interface dev.openfeature.sdk.Client

Return an optional client-level evaluation context.

getEvaluationContext() - Method in class dev.openfeature.sdk.OpenFeatureAPI

Gets the global evaluation context, which will be used for all evaluations.

getEvaluationContext() - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

Return an optional client-level evaluation context.

getFloat(String) - Method in class dev.openfeature.sdk.ImmutableMetadata

Retrieve a Float value for the given key.

getHooks() - Method in interface dev.openfeature.sdk.Client

Fetch the hooks associated to this client.

getHooks() - Method in class dev.openfeature.sdk.OpenFeatureAPI

Fetch the hooks associated to this client.

getHooks() - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

Fetch the hooks associated to this client.

getInstance() - Static method in class dev.openfeature.sdk.OpenFeatureAPI

Provisions the OpenFeatureAPI singleton (if needed) and returns it.

getInteger(String) - Method in class dev.openfeature.sdk.ImmutableMetadata

Retrieve a Integer value for the given key.

getIntegerDetails(String, Integer) - Method in interface dev.openfeature.sdk.Features

getIntegerDetails(String, Integer, EvaluationContext) - Method in interface dev.openfeature.sdk.Features

getIntegerDetails(String, Integer, EvaluationContext, FlagEvaluationOptions) - Method in interface dev.openfeature.sdk.Features

getIntegerDetails(String, Integer) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getIntegerDetails(String, Integer, EvaluationContext) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getIntegerDetails(String, Integer, EvaluationContext, FlagEvaluationOptions) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getIntegerEvaluation(String, Integer, EvaluationContext) - Method in interface dev.openfeature.sdk.FeatureProvider

getIntegerEvaluation(String, Integer, EvaluationContext) - Method in class dev.openfeature.sdk.NoOpProvider

getIntegerEvaluation(String, Integer, EvaluationContext) - Method in class dev.openfeature.sdk.providers.memory.InMemoryProvider

getIntegerValue(String, Integer) - Method in interface dev.openfeature.sdk.Features

getIntegerValue(String, Integer, EvaluationContext) - Method in interface dev.openfeature.sdk.Features

getIntegerValue(String, Integer, EvaluationContext, FlagEvaluationOptions) - Method in interface dev.openfeature.sdk.Features

getIntegerValue(String, Integer) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getIntegerValue(String, Integer, EvaluationContext) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getIntegerValue(String, Integer, EvaluationContext, FlagEvaluationOptions) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getLong(String) - Method in class dev.openfeature.sdk.ImmutableMetadata

Retrieve a Long value for the given key.

getMetadata() - Method in interface dev.openfeature.sdk.Client

getMetadata() - Method in interface dev.openfeature.sdk.FeatureProvider

getMetadata() - Method in class dev.openfeature.sdk.NoOpProvider

getMetadata() - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getMetadata() - Method in class dev.openfeature.sdk.providers.memory.InMemoryProvider

getName() - Method in interface dev.openfeature.sdk.ClientMetadata

Deprecated.

getName() - Method in interface dev.openfeature.sdk.Metadata

getObjectDetails(String, Value) - Method in interface dev.openfeature.sdk.Features

getObjectDetails(String, Value, EvaluationContext) - Method in interface dev.openfeature.sdk.Features

getObjectDetails(String, Value, EvaluationContext, FlagEvaluationOptions) - Method in interface dev.openfeature.sdk.Features

getObjectDetails(String, Value) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getObjectDetails(String, Value, EvaluationContext) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getObjectDetails(String, Value, EvaluationContext, FlagEvaluationOptions) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getObjectEvaluation(String, Value, EvaluationContext) - Method in interface dev.openfeature.sdk.FeatureProvider

getObjectEvaluation(String, Value, EvaluationContext) - Method in class dev.openfeature.sdk.NoOpProvider

getObjectEvaluation(String, Value, EvaluationContext) - Method in class dev.openfeature.sdk.providers.memory.InMemoryProvider

getObjectValue(String, Value) - Method in interface dev.openfeature.sdk.Features

getObjectValue(String, Value, EvaluationContext) - Method in interface dev.openfeature.sdk.Features

getObjectValue(String, Value, EvaluationContext, FlagEvaluationOptions) - Method in interface dev.openfeature.sdk.Features

getObjectValue(String, Value) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getObjectValue(String, Value, EvaluationContext) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getObjectValue(String, Value, EvaluationContext, FlagEvaluationOptions) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getProvider() - Method in class dev.openfeature.sdk.OpenFeatureAPI

Return the default provider.

getProvider(String) - Method in class dev.openfeature.sdk.OpenFeatureAPI

Fetch a provider for a domain.

getProviderHooks() - Method in interface dev.openfeature.sdk.FeatureProvider

getProviderMetadata() - Method in class dev.openfeature.sdk.OpenFeatureAPI

Get metadata about the default provider.

getProviderMetadata(String) - Method in class dev.openfeature.sdk.OpenFeatureAPI

Get metadata about a registered provider using the client name.

getReason() - Method in interface dev.openfeature.sdk.BaseEvaluation

Describes how we came to the value that we're returning.

getState() - Method in class dev.openfeature.sdk.EventProvider

Returns a representation of the current readiness of the provider.

getState() - Method in interface dev.openfeature.sdk.FeatureProvider

Returns a representation of the current readiness of the provider.

getState() - Method in class dev.openfeature.sdk.NoOpProvider

getString(String) - Method in class dev.openfeature.sdk.ImmutableMetadata

Retrieve a String value for the given key.

getStringDetails(String, String) - Method in interface dev.openfeature.sdk.Features

getStringDetails(String, String, EvaluationContext) - Method in interface dev.openfeature.sdk.Features

getStringDetails(String, String, EvaluationContext, FlagEvaluationOptions) - Method in interface dev.openfeature.sdk.Features

getStringDetails(String, String) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getStringDetails(String, String, EvaluationContext) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getStringDetails(String, String, EvaluationContext, FlagEvaluationOptions) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getStringEvaluation(String, String, EvaluationContext) - Method in interface dev.openfeature.sdk.FeatureProvider

getStringEvaluation(String, String, EvaluationContext) - Method in class dev.openfeature.sdk.NoOpProvider

getStringEvaluation(String, String, EvaluationContext) - Method in class dev.openfeature.sdk.providers.memory.InMemoryProvider

getStringValue(String, String) - Method in interface dev.openfeature.sdk.Features

getStringValue(String, String, EvaluationContext) - Method in interface dev.openfeature.sdk.Features

getStringValue(String, String, EvaluationContext, FlagEvaluationOptions) - Method in interface dev.openfeature.sdk.Features

getStringValue(String, String) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getStringValue(String, String, EvaluationContext) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getStringValue(String, String, EvaluationContext, FlagEvaluationOptions) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

getTargetingKey() - Method in interface dev.openfeature.sdk.EvaluationContext

getTargetingKey() - Method in class dev.openfeature.sdk.ImmutableContext

Retrieve targetingKey from the context.

getTargetingKey() - Method in class dev.openfeature.sdk.MutableContext

Retrieve targetingKey from the context.

getTransactionContext() - Method in class dev.openfeature.sdk.NoOpTransactionContextPropagator

Returns the currently defined transaction context using the registered transaction context propagator.

getTransactionContext() - Method in class dev.openfeature.sdk.ThreadLocalTransactionContextPropagator

Returns the currently defined transaction context using the registered transaction context propagator.

getTransactionContext() - Method in interface dev.openfeature.sdk.TransactionContextPropagator

Returns the currently defined transaction context using the registered transaction context propagator.

getTransactionContextPropagator() - Method in class dev.openfeature.sdk.OpenFeatureAPI

Return the transaction context propagator.

getValue() - Method in interface dev.openfeature.sdk.BaseEvaluation

Returns the resolved value of the evaluation.

getValue(String, Class<T>) - Method in class dev.openfeature.sdk.ImmutableMetadata

Generic value retrieval for the given key.

getValue(String) - Method in class dev.openfeature.sdk.ImmutableStructure

getValue(String) - Method in class dev.openfeature.sdk.MutableStructure

getValue(String) - Method in interface dev.openfeature.sdk.Structure

Get the value indexed by key.

getVariant() - Method in interface dev.openfeature.sdk.BaseEvaluation

Returns an identifier for this value, if applicable.

H

Hook<T> - Interface in dev.openfeature.sdk

An extension point which can run around flag resolution.

HookContext<T> - Class in dev.openfeature.sdk

A data class to hold immutable context that Hook instances use.

HookContext() - Constructor for class dev.openfeature.sdk.HookContext

I

ImmutableContext - Class in dev.openfeature.sdk

The EvaluationContext is a container for arbitrary contextual data that can be used as a basis for dynamic evaluation.

ImmutableContext() - Constructor for class dev.openfeature.sdk.ImmutableContext

Create an immutable context with an empty targeting_key and attributes provided.

ImmutableContext(String) - Constructor for class dev.openfeature.sdk.ImmutableContext

Create an immutable context with given targeting_key provided.

ImmutableContext(Map<String, Value>) - Constructor for class dev.openfeature.sdk.ImmutableContext

Create an immutable context with an attributes provided.

ImmutableContext(String, Map<String, Value>) - Constructor for class dev.openfeature.sdk.ImmutableContext

Create an immutable context with given targetingKey and attributes provided.

ImmutableMetadata - Class in dev.openfeature.sdk

Immutable Flag Metadata representation.

ImmutableMetadata.ImmutableMetadataBuilder - Class in dev.openfeature.sdk

Immutable builder for ImmutableMetadata.

ImmutableStructure - Class in dev.openfeature.sdk

ImmutableStructure represents a potentially nested object type which is used to represent structured data.

ImmutableStructure() - Constructor for class dev.openfeature.sdk.ImmutableStructure

create an immutable structure with the empty attributes.

ImmutableStructure(Map<String, Value>) - Constructor for class dev.openfeature.sdk.ImmutableStructure

create immutable structure with the given attributes.

initialize(EvaluationContext) - Method in interface dev.openfeature.sdk.FeatureProvider

This method is called before a provider is used to evaluate flags.

initialize(EvaluationContext) - Method in class dev.openfeature.sdk.providers.memory.InMemoryProvider

Initializes the provider.

InMemoryProvider - Class in dev.openfeature.sdk.providers.memory

In-memory provider.

InMemoryProvider(Map<String, Flag<?>>) - Constructor for class dev.openfeature.sdk.providers.memory.InMemoryProvider

instantiateErrorByErrorCode(ErrorCode, String) - Static method in class dev.openfeature.sdk.exceptions.ExceptionUtils

Creates an Error for the specific error code.

IntegerHook - Interface in dev.openfeature.sdk

An extension point which can run around flag resolution.

InvalidContextError - Exception in dev.openfeature.sdk.exceptions

The evaluation context does not meet provider requirements.

InvalidContextError() - Constructor for exception dev.openfeature.sdk.exceptions.InvalidContextError

isBoolean() - Method in class dev.openfeature.sdk.Value

Check if this Value represents a Boolean.

isInstant() - Method in class dev.openfeature.sdk.Value

Check if this Value represents an Instant.

isList() - Method in class dev.openfeature.sdk.Value

Check if this Value represents a List of Values.

isNull() - Method in class dev.openfeature.sdk.Value

Check if this Value represents null.

isNumber() - Method in class dev.openfeature.sdk.Value

Check if this Value represents a numeric value.

isString() - Method in class dev.openfeature.sdk.Value

Check if this Value represents a String.

isStructure() - Method in class dev.openfeature.sdk.Value

Check if this Value represents a Structure.

K

keySet() - Method in class dev.openfeature.sdk.ImmutableStructure

keySet() - Method in class dev.openfeature.sdk.MutableStructure

keySet() - Method in interface dev.openfeature.sdk.Structure

Get all keys.

L

LoggingHook - Class in dev.openfeature.sdk.hooks.logging

A hook for logging flag evaluations.

LoggingHook() - Constructor for class dev.openfeature.sdk.hooks.logging.LoggingHook

Construct a new LoggingHook.

LoggingHook(boolean) - Constructor for class dev.openfeature.sdk.hooks.logging.LoggingHook

Construct a new LoggingHook.

M

mapToStructure(Map<String, Object>) - Static method in interface dev.openfeature.sdk.Structure

Transform an object map to a Structure type.

merge(EvaluationContext) - Method in interface dev.openfeature.sdk.EvaluationContext

Merges this EvaluationContext object with the second overriding the this in case of conflict.

merge(EvaluationContext) - Method in class dev.openfeature.sdk.ImmutableContext

Merges this EvaluationContext object with the passed EvaluationContext, overriding in case of conflict.

merge(List<T>...) - Static method in class dev.openfeature.sdk.internal.ObjectUtils

Concatenate a bunch of lists.

merge(EvaluationContext) - Method in class dev.openfeature.sdk.MutableContext

Merges this EvaluationContext objects with the second overriding the in case of conflict.

merge(Function<Map<String, Value>, Structure>, Map<String, Value>, Map<String, Value>) - Method in interface dev.openfeature.sdk.Structure

Recursively merges the base map with the overriding map.

Metadata - Interface in dev.openfeature.sdk

Holds identifying information about a given entity.

MutableContext - Class in dev.openfeature.sdk

The EvaluationContext is a container for arbitrary contextual data that can be used as a basis for dynamic evaluation.

MutableContext() - Constructor for class dev.openfeature.sdk.MutableContext

MutableContext(String) - Constructor for class dev.openfeature.sdk.MutableContext

MutableContext(Map<String, Value>) - Constructor for class dev.openfeature.sdk.MutableContext

MutableContext(String, Map<String, Value>) - Constructor for class dev.openfeature.sdk.MutableContext

Create a mutable context with given targetingKey and attributes provided.

MutableStructure - Class in dev.openfeature.sdk

MutableStructure represents a potentially nested object type which is used to represent structured data.

MutableStructure() - Constructor for class dev.openfeature.sdk.MutableStructure

MutableStructure(Map<String, Value>) - Constructor for class dev.openfeature.sdk.MutableStructure

N

NoOpProvider - Class in dev.openfeature.sdk

A FeatureProvider that simply returns the default values passed to it.

NoOpProvider() - Constructor for class dev.openfeature.sdk.NoOpProvider

NoOpTransactionContextPropagator - Class in dev.openfeature.sdk

A TransactionContextPropagator that simply returns empty context.

NoOpTransactionContextPropagator() - Constructor for class dev.openfeature.sdk.NoOpTransactionContextPropagator

O

objectToValue(Object) - Static method in class dev.openfeature.sdk.Value

Wrap an object into a Value.

ObjectUtils - Class in dev.openfeature.sdk.internal

ObjectUtils() - Constructor for class dev.openfeature.sdk.internal.ObjectUtils

on(ProviderEvent, Consumer<EventDetails>) - Method in interface dev.openfeature.sdk.EventBus

Add a handler for the specified ProviderEvent.

on(ProviderEvent, Consumer<EventDetails>) - Method in class dev.openfeature.sdk.OpenFeatureAPI

Add a handler for the specified ProviderEvent.

on(ProviderEvent, Consumer<EventDetails>) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

Add a handler for the specified ProviderEvent.

onProviderConfigurationChanged(Consumer<EventDetails>) - Method in interface dev.openfeature.sdk.EventBus

Add a handler for the ProviderEvent.PROVIDER_CONFIGURATION_CHANGED event.

onProviderConfigurationChanged(Consumer<EventDetails>) - Method in class dev.openfeature.sdk.OpenFeatureAPI

Add a handler for the ProviderEvent.PROVIDER_CONFIGURATION_CHANGED event.

onProviderConfigurationChanged(Consumer<EventDetails>) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

Add a handler for the ProviderEvent.PROVIDER_CONFIGURATION_CHANGED event.

onProviderError(Consumer<EventDetails>) - Method in interface dev.openfeature.sdk.EventBus

Add a handler for the ProviderEvent.PROVIDER_STALE event.

onProviderError(Consumer<EventDetails>) - Method in class dev.openfeature.sdk.OpenFeatureAPI

Add a handler for the ProviderEvent.PROVIDER_STALE event.

onProviderError(Consumer<EventDetails>) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

Add a handler for the ProviderEvent.PROVIDER_STALE event.

onProviderReady(Consumer<EventDetails>) - Method in interface dev.openfeature.sdk.EventBus

Add a handler for the ProviderEvent.PROVIDER_READY event.

onProviderReady(Consumer<EventDetails>) - Method in class dev.openfeature.sdk.OpenFeatureAPI

Add a handler for the ProviderEvent.PROVIDER_READY event.

onProviderReady(Consumer<EventDetails>) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

Add a handler for the ProviderEvent.PROVIDER_READY event.

onProviderStale(Consumer<EventDetails>) - Method in interface dev.openfeature.sdk.EventBus

Add a handler for the ProviderEvent.PROVIDER_ERROR event.

onProviderStale(Consumer<EventDetails>) - Method in class dev.openfeature.sdk.OpenFeatureAPI

Add a handler for the ProviderEvent.PROVIDER_ERROR event.

onProviderStale(Consumer<EventDetails>) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

Add a handler for the ProviderEvent.PROVIDER_ERROR event.

OpenFeatureAPI - Class in dev.openfeature.sdk

A global singleton which holds base configuration for the OpenFeature library.

OpenFeatureAPI() - Constructor for class dev.openfeature.sdk.OpenFeatureAPI

OpenFeatureClient - Class in dev.openfeature.sdk

Deprecated.

// TODO: eventually we will make this non-public. See issue #872

OpenFeatureClient(OpenFeatureAPI, String, String) - Constructor for class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

Do not use this constructor. It's for internal use only. Clients created using it will not run event handlers. Use the OpenFeatureAPI's getClient factory method instead.

OpenFeatureError - Exception in dev.openfeature.sdk.exceptions

OpenFeatureError() - Constructor for exception dev.openfeature.sdk.exceptions.OpenFeatureError

P

ParseError - Exception in dev.openfeature.sdk.exceptions

An error was encountered parsing data, such as a flag configuration.

ParseError() - Constructor for exception dev.openfeature.sdk.exceptions.ParseError

PASSED_IN_DEFAULT - Static variable in class dev.openfeature.sdk.NoOpProvider

ProviderEvaluation<T> - Class in dev.openfeature.sdk

Contains information about how the a flag was evaluated, including the resolved value.

ProviderEvaluation() - Constructor for class dev.openfeature.sdk.ProviderEvaluation

ProviderEvent - Enum in dev.openfeature.sdk

Provider event types.

ProviderEventDetails - Class in dev.openfeature.sdk

The details of a particular event.

ProviderEventDetails() - Constructor for class dev.openfeature.sdk.ProviderEventDetails

ProviderNotReadyError - Exception in dev.openfeature.sdk.exceptions

ProviderNotReadyError() - Constructor for exception dev.openfeature.sdk.exceptions.ProviderNotReadyError

ProviderState - Enum in dev.openfeature.sdk

Indicates the state of the provider.

R

readLockAutoCloseable() - Method in class dev.openfeature.sdk.internal.AutoCloseableReentrantReadWriteLock

Get the multi read lock as an AutoCloseableLock.

Reason - Enum in dev.openfeature.sdk

Predefined resolution reasons.

removeHandler(ProviderEvent, Consumer<EventDetails>) - Method in interface dev.openfeature.sdk.EventBus

Remove the previously attached handler by reference.

removeHandler(ProviderEvent, Consumer<EventDetails>) - Method in class dev.openfeature.sdk.OpenFeatureAPI

Remove the previously attached handler by reference.

removeHandler(ProviderEvent, Consumer<EventDetails>) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

Remove the previously attached handler by reference.

S

setEvaluationContext(EvaluationContext) - Method in interface dev.openfeature.sdk.Client

Set the client-level evaluation context.

setEvaluationContext(EvaluationContext) - Method in class dev.openfeature.sdk.OpenFeatureAPI

Sets the global evaluation context, which will be used for all evaluations.

setEvaluationContext(EvaluationContext) - Method in class dev.openfeature.sdk.OpenFeatureClient

Deprecated.

Set the client-level evaluation context.

setProvider(FeatureProvider) - Method in class dev.openfeature.sdk.OpenFeatureAPI

Set the default provider.

setProvider(String, FeatureProvider) - Method in class dev.openfeature.sdk.OpenFeatureAPI

Add a provider for a domain.

setProviderAndWait(FeatureProvider) - Method in class dev.openfeature.sdk.OpenFeatureAPI

Set the default provider and wait for initialization to finish.

setProviderAndWait(String, FeatureProvider) - Method in class dev.openfeature.sdk.OpenFeatureAPI

Add a provider for a domain and wait for initialization to finish.

setTargetingKey(String) - Method in class dev.openfeature.sdk.MutableContext

Override or set targeting key for this mutable context.

setTransactionContext(EvaluationContext) - Method in class dev.openfeature.sdk.NoOpTransactionContextPropagator

Sets the transaction context.

setTransactionContext(EvaluationContext) - Method in class dev.openfeature.sdk.OpenFeatureAPI

Sets the transaction context using the registered transaction context propagator.

setTransactionContext(EvaluationContext) - Method in class dev.openfeature.sdk.ThreadLocalTransactionContextPropagator

Sets the transaction context.

setTransactionContext(EvaluationContext) - Method in interface dev.openfeature.sdk.TransactionContextPropagator

Sets the transaction context.

setTransactionContextPropagator(TransactionContextPropagator) - Method in class dev.openfeature.sdk.OpenFeatureAPI

Sets the transaction context propagator.

shutdown() - Method in interface dev.openfeature.sdk.FeatureProvider

This method is called when a new provider is about to be used to evaluate flags, or the SDK is shut down.

shutdown() - Method in class dev.openfeature.sdk.OpenFeatureAPI

Shut down and reset the current status of OpenFeature API.

StringHook - Interface in dev.openfeature.sdk

An extension point which can run around flag resolution.

Structure - Interface in dev.openfeature.sdk

Structure represents a potentially nested object type which is used to represent structured data.

supportsFlagValueType(FlagValueType) - Method in interface dev.openfeature.sdk.BooleanHook

supportsFlagValueType(FlagValueType) - Method in interface dev.openfeature.sdk.DoubleHook

supportsFlagValueType(FlagValueType) - Method in interface dev.openfeature.sdk.Hook

supportsFlagValueType(FlagValueType) - Method in interface dev.openfeature.sdk.IntegerHook

supportsFlagValueType(FlagValueType) - Method in interface dev.openfeature.sdk.StringHook

T

TARGETING_KEY - Static variable in interface dev.openfeature.sdk.EvaluationContext

TargetingKeyMissingError - Exception in dev.openfeature.sdk.exceptions

The provider requires a targeting key and one was not provided in the evaluation context.

TargetingKeyMissingError() - Constructor for exception dev.openfeature.sdk.exceptions.TargetingKeyMissingError

ThreadLocalTransactionContextPropagator - Class in dev.openfeature.sdk

A ThreadLocalTransactionContextPropagator is a transactional context propagator that uses a ThreadLocal to persist a transactional context for the duration of a single thread.

ThreadLocalTransactionContextPropagator() - Constructor for class dev.openfeature.sdk.ThreadLocalTransactionContextPropagator

TransactionContextPropagator - Interface in dev.openfeature.sdk

TransactionContextPropagator is responsible for persisting a transactional context for the duration of a single transaction.

TriConsumer<T,U,V> - Interface in dev.openfeature.sdk.internal

Like BiConsumer but with 3 params.

TypeMismatchError - Exception in dev.openfeature.sdk.exceptions

The type of the flag value does not match the expected type.

TypeMismatchError() - Constructor for exception dev.openfeature.sdk.exceptions.TypeMismatchError

U

updateFlag(String, Flag<?>) - Method in class dev.openfeature.sdk.providers.memory.InMemoryProvider

Updates a single provider flag configuration.

updateFlags(Map<String, Flag<?>>) - Method in class dev.openfeature.sdk.providers.memory.InMemoryProvider

Updates the provider flags configuration.

V

Value - Class in dev.openfeature.sdk

Values serve as a generic return type for structure data from providers.

Value() - Constructor for class dev.openfeature.sdk.Value

Construct a new null Value.

Value(Object) - Constructor for class dev.openfeature.sdk.Value

Construct a new Value with an Object.

Value(Value) - Constructor for class dev.openfeature.sdk.Value

Value(Boolean) - Constructor for class dev.openfeature.sdk.Value

Value(String) - Constructor for class dev.openfeature.sdk.Value

Value(Integer) - Constructor for class dev.openfeature.sdk.Value

Value(Double) - Constructor for class dev.openfeature.sdk.Value

Value(Structure) - Constructor for class dev.openfeature.sdk.Value

Value(List<Value>) - Constructor for class dev.openfeature.sdk.Value

Value(Instant) - Constructor for class dev.openfeature.sdk.Value

ValueNotConvertableError - Exception in dev.openfeature.sdk.exceptions

The value can not be converted to a Value.

ValueNotConvertableError() - Constructor for exception dev.openfeature.sdk.exceptions.ValueNotConvertableError

valueOf(String) - Static method in enum dev.openfeature.sdk.ErrorCode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum dev.openfeature.sdk.FlagValueType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum dev.openfeature.sdk.ProviderEvent

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum dev.openfeature.sdk.ProviderState

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum dev.openfeature.sdk.Reason

Returns the enum constant of this type with the specified name.

values() - Static method in enum dev.openfeature.sdk.ErrorCode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum dev.openfeature.sdk.FlagValueType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum dev.openfeature.sdk.ProviderEvent

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum dev.openfeature.sdk.ProviderState

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum dev.openfeature.sdk.Reason

Returns an array containing the constants of this enum type, in the order they are declared.

W

writeLockAutoCloseable() - Method in class dev.openfeature.sdk.internal.AutoCloseableReentrantReadWriteLock

Get the single write lock as an AutoCloseableLock.

A B C D E F G H I K L M N O P R S T U V W