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

A

addOnClientReady(Runnable) - Method in class com.configcat.ConfigCatHooks

Subscribes to the onReady event.

addOnConfigChanged(Consumer<Map<String, Setting>>) - Method in class com.configcat.ConfigCatHooks

Subscribes to the onConfigChanged event.

addOnError(Consumer<String>) - Method in class com.configcat.ConfigCatHooks

Subscribes to the onError event.

addOnFlagEvaluated(Consumer<EvaluationDetails<Object>>) - Method in class com.configcat.ConfigCatHooks

Subscribes to the onFlagEvaluated event.

autoPoll() - Static method in class com.configcat.PollingModes

Set up the auto polling mode with default parameters.

autoPoll(int) - Static method in class com.configcat.PollingModes

Set up the auto polling mode with custom parameters.

autoPoll(int, int) - Static method in class com.configcat.PollingModes

Set up the auto polling mode with custom parameters.

B

baseUrl(String) - Method in class com.configcat.ConfigCatClient.Options

Sets the base ConfigCat CDN url.

build(String) - Method in class com.configcat.User.Builder

Builds the configured User instance.

Builder() - Constructor for class com.configcat.User.Builder

C

cache(ConfigCache) - Method in class com.configcat.ConfigCatClient.Options

Sets the internal cache implementation.

classPathResource(String) - Static method in class com.configcat.OverrideDataSourceBuilder

Creates an override data source builder that describes a classpath resource data source.

clearDefaultUser() - Method in class com.configcat.ConfigCatClient

clearDefaultUser() - Method in interface com.configcat.ConfigurationProvider

Set default user value to null.

close() - Method in class com.configcat.ConfigCatClient

close() - Method in class com.configcat.ConfigService

closeAll() - Static method in class com.configcat.ConfigCatClient

Close all ConfigCatClient instances.

com.configcat - package com.configcat

ConfigCache - Class in com.configcat

A cache API used to make custom cache implementations for ConfigCatClient.

ConfigCache() - Constructor for class com.configcat.ConfigCache

ConfigCatClient - Class in com.configcat

A client for handling configurations provided by ConfigCat.

ConfigCatClient.Options - Class in com.configcat

Options for configuring ConfigCatClient instance.

ConfigCatHooks - Class in com.configcat

ConfigCatHooks() - Constructor for class com.configcat.ConfigCatHooks

ConfigService - Class in com.configcat

ConfigService(String, ConfigFetcher, PollingMode, ConfigCache, ConfigCatLogger, boolean, ConfigCatHooks) - Constructor for class com.configcat.ConfigService

ConfigurationProvider - Interface in com.configcat

Defines the public interface of the ConfigCatClient.

country(String) - Method in class com.configcat.User.Builder

Optional.

custom(Map<String, String>) - Method in class com.configcat.User.Builder

Optional.

D

dataGovernance(DataGovernance) - Method in class com.configcat.ConfigCatClient.Options

Default: Global.

DataGovernance - Enum in com.configcat

Describes the location of your feature flag and setting data within the ConfigCat CDN.

defaultUser(User) - Method in class com.configcat.ConfigCatClient.Options

Sets the default user.

E

email(String) - Method in class com.configcat.User.Builder

Optional.

error() - Method in class com.configcat.RefreshResult

EvaluationDetails<T> - Class in com.configcat

Additional information about flag evaluation.

EvaluationDetails(T, String, String, User, boolean, String, long, RolloutRule, PercentageRule) - Constructor for class com.configcat.EvaluationDetails

F

flagOverrides(OverrideDataSourceBuilder, OverrideBehaviour) - Method in class com.configcat.ConfigCatClient.Options

Sets feature flag and setting overrides.

forceRefresh() - Method in class com.configcat.ConfigCatClient

forceRefresh() - Method in interface com.configcat.ConfigurationProvider

Initiates a force refresh synchronously on the cached configuration.

forceRefreshAsync() - Method in class com.configcat.ConfigCatClient

forceRefreshAsync() - Method in interface com.configcat.ConfigurationProvider

Initiates a force refresh asynchronously on the cached configuration.

G

get(String) - Static method in class com.configcat.ConfigCatClient

Get a singleton ConfigCat Client for the sdk key, create a new client if not existed yet.

get(String, Consumer<ConfigCatClient.Options>) - Static method in class com.configcat.ConfigCatClient

Creates a new or gets an already existing ConfigCatClient for the given sdkKey.

getAllKeys() - Method in class com.configcat.ConfigCatClient

getAllKeys() - Method in interface com.configcat.ConfigurationProvider

Gets a collection of all setting keys.

getAllKeysAsync() - Method in class com.configcat.ConfigCatClient

getAllKeysAsync() - Method in interface com.configcat.ConfigurationProvider

Gets a collection of all setting keys asynchronously.

getAllValueDetails(User) - Method in class com.configcat.ConfigCatClient

getAllValueDetails(User) - Method in interface com.configcat.ConfigurationProvider

Gets the detailed values of all feature flags or settings synchronously.

getAllValueDetailsAsync(User) - Method in class com.configcat.ConfigCatClient

getAllValueDetailsAsync(User) - Method in interface com.configcat.ConfigurationProvider

Gets the detailed values of all feature flags or settings asynchronously.

getAllValues(User) - Method in class com.configcat.ConfigCatClient

getAllValues(User) - Method in interface com.configcat.ConfigurationProvider

Gets the values of all feature flags or settings synchronously.

getAllValuesAsync(User) - Method in class com.configcat.ConfigCatClient

getAllValuesAsync(User) - Method in interface com.configcat.ConfigurationProvider

Gets the values of all feature flags or settings asynchronously.

getError() - Method in class com.configcat.EvaluationDetails

In case of an error, this field contains the error message.

getFetchTimeUnixMilliseconds() - Method in class com.configcat.EvaluationDetails

The last fetch time of the config.json in unix milliseconds format.

getHooks() - Method in class com.configcat.ConfigCatClient

getHooks() - Method in interface com.configcat.ConfigurationProvider

Access to hooks for event subscription.

getKey() - Method in class com.configcat.EvaluationDetails

The key of the evaluated feature flag or setting.

getKeyAndValue(Class<T>, String) - Method in class com.configcat.ConfigCatClient

getKeyAndValue(Class<T>, String) - Method in interface com.configcat.ConfigurationProvider

Gets the key of a setting and its value identified by the given Variation ID (analytics).

getKeyAndValueAsync(Class<T>, String) - Method in class com.configcat.ConfigCatClient

getKeyAndValueAsync(Class<T>, String) - Method in interface com.configcat.ConfigurationProvider

Gets the key of a setting and its value identified by the given Variation ID (analytics).

getMatchedEvaluationPercentageRule() - Method in class com.configcat.EvaluationDetails

If the evaluation was based on a percentage rule, this field contains that specific rule.

getMatchedEvaluationRule() - Method in class com.configcat.EvaluationDetails

If the evaluation was based on a targeting rule, this field contains that specific rule.

getSettings() - Method in class com.configcat.ConfigService

getUser() - Method in class com.configcat.EvaluationDetails

The user object that was used for evaluation.

getValue(Class<T>, String, T) - Method in class com.configcat.ConfigCatClient

getValue(Class<T>, String, User, T) - Method in class com.configcat.ConfigCatClient

getValue(Class<T>, String, T) - Method in interface com.configcat.ConfigurationProvider

Gets the value of a feature flag or setting as T identified by the given key.

getValue(Class<T>, String, User, T) - Method in interface com.configcat.ConfigurationProvider

Gets the value of a feature flag or setting as T asynchronously identified by the given key.

getValue() - Method in class com.configcat.EvaluationDetails

The evaluated value of the feature flag or setting.

getValueAsync(Class<T>, String, T) - Method in class com.configcat.ConfigCatClient

getValueAsync(Class<T>, String, User, T) - Method in class com.configcat.ConfigCatClient

getValueAsync(Class<T>, String, T) - Method in interface com.configcat.ConfigurationProvider

Gets the value of a feature flag or setting as T identified by the given key.

getValueAsync(Class<T>, String, User, T) - Method in interface com.configcat.ConfigurationProvider

Gets the value of a feature flag or setting as T asynchronously identified by the given key.

getValueDetails(Class<T>, String, T) - Method in class com.configcat.ConfigCatClient

getValueDetails(Class<T>, String, User, T) - Method in class com.configcat.ConfigCatClient

getValueDetails(Class<T>, String, T) - Method in interface com.configcat.ConfigurationProvider

Gets the value of a feature flag or setting as T identified by the given key.

getValueDetails(Class<T>, String, User, T) - Method in interface com.configcat.ConfigurationProvider

Gets the value of a feature flag or setting as T identified by the given key.

getValueDetailsAsync(Class<T>, String, T) - Method in class com.configcat.ConfigCatClient

getValueDetailsAsync(Class<T>, String, User, T) - Method in class com.configcat.ConfigCatClient

getValueDetailsAsync(Class<T>, String, T) - Method in interface com.configcat.ConfigurationProvider

Gets the value of a feature flag or setting as T asynchronously identified by the given key.

getValueDetailsAsync(Class<T>, String, User, T) - Method in interface com.configcat.ConfigurationProvider

Gets the value of a feature flag or setting as T asynchronously identified by the given key.

getVariationId() - Method in class com.configcat.EvaluationDetails

The variationID is the identifier of the evaluated value.

H

hooks() - Method in class com.configcat.ConfigCatClient.Options

Set the client hooks.

httpClient(OkHttpClient) - Method in class com.configcat.ConfigCatClient.Options

Sets the underlying http client which will be used to fetch the latest configuration.

I

isClosed() - Method in class com.configcat.ConfigCatClient

isClosed() - Method in interface com.configcat.ConfigurationProvider

Get the client closed status.

isDefaultValue() - Method in class com.configcat.EvaluationDetails

True when the default value was returned, possibly due to an error.

isOffline() - Method in class com.configcat.ConfigCatClient

isOffline() - Method in class com.configcat.ConfigService

isOffline() - Method in interface com.configcat.ConfigurationProvider

Get the client offline mode status.

isSuccess() - Method in class com.configcat.RefreshResult

L

lazyLoad() - Static method in class com.configcat.PollingModes

Set up a lazy polling mode with default parameters.

lazyLoad(int) - Static method in class com.configcat.PollingModes

Set up a lazy polling mode with custom parameters.

localFile(String, boolean) - Static method in class com.configcat.OverrideDataSourceBuilder

Creates an override data source builder that describes a local file data source.

logLevel(LogLevel) - Method in class com.configcat.ConfigCatClient.Options

Default: Warning.

LogLevel - Enum in com.configcat

Describes the log level.

M

manualPoll() - Static method in class com.configcat.PollingModes

Set up the manual polling mode.

map(Map<String, Object>) - Static method in class com.configcat.OverrideDataSourceBuilder

Creates an override data source builder that describes a map data source.

N

newBuilder() - Static method in class com.configcat.User

Creates a new builder instance.

O

offline(boolean) - Method in class com.configcat.ConfigCatClient.Options

Set client offline mode.

Options() - Constructor for class com.configcat.ConfigCatClient.Options

OverrideBehaviour - Enum in com.configcat

Describes how the overrides should behave.

OverrideDataSourceBuilder - Class in com.configcat

Describes a data source builder.

P

pollingMode(PollingMode) - Method in class com.configcat.ConfigCatClient.Options

Sets the internal refresh policy implementation.

PollingMode - Class in com.configcat

The base class of a polling mode configuration.

PollingMode() - Constructor for class com.configcat.PollingMode

PollingModes - Class in com.configcat

Describes the polling modes.

PollingModes() - Constructor for class com.configcat.PollingModes

R

read(String) - Method in class com.configcat.ConfigCache

Child classes has to implement this method, the ConfigCatClient uses it to get the actual value from the cache.

refresh() - Method in class com.configcat.ConfigService

RefreshResult - Class in com.configcat

Represents the result of a forceRefresh() call.

S

setDefaultUser(User) - Method in class com.configcat.ConfigCatClient

setDefaultUser(User) - Method in interface com.configcat.ConfigurationProvider

Sets defaultUser value.

setOffline() - Method in class com.configcat.ConfigCatClient

setOffline() - Method in class com.configcat.ConfigService

setOffline() - Method in interface com.configcat.ConfigurationProvider

Set the client to offline mode.

setOnline() - Method in class com.configcat.ConfigCatClient

setOnline() - Method in class com.configcat.ConfigService

setOnline() - Method in interface com.configcat.ConfigurationProvider

Set the client to online mode.

T

toString() - Method in class com.configcat.User

U

User - Class in com.configcat

An object containing attributes to properly identify a given user for variation evaluation.

User.Builder - Class in com.configcat

A builder that helps construct a User instance.

V

valueOf(String) - Static method in enum com.configcat.DataGovernance

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

valueOf(String) - Static method in enum com.configcat.LogLevel

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

valueOf(String) - Static method in enum com.configcat.OverrideBehaviour

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

values() - Static method in enum com.configcat.DataGovernance

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

values() - Static method in enum com.configcat.LogLevel

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

values() - Static method in enum com.configcat.OverrideBehaviour

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

W

write(String, String) - Method in class com.configcat.ConfigCache

* Child classes has to implement this method, the ConfigCatClient uses it to set the actual cached value.

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