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

A

addConfigurationChangeListener(ConfigurationChangeListener) - Method in class com.configcat.AutoPollingPolicy

Subscribes a new listener to the configuration changed event.

asyncRefresh(boolean) - Method in class com.configcat.LazyLoadingPolicy.Builder

Sets whether the cache should refresh itself asynchronously or synchronously.

AutoPollingPolicy - Class in com.configcat

Describes a RefreshPolicy which polls the latest configuration over HTTP and updates the local cache repeatedly.

AutoPollingPolicy.Builder - Class in com.configcat

A builder that helps construct a AutoPollingPolicy instance.

autoPollIntervalInSeconds(int) - Method in class com.configcat.AutoPollingPolicy.Builder

Sets at least how often this policy should fetch the latest configuration and refresh the cache.

B

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

Sets the base ConfigCat CDN url.

build(ConfigFetcher, ConfigCache) - Method in class com.configcat.AutoPollingPolicy.Builder

Builds the configured AutoPollingPolicy instance.

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

Builds the configured ConfigCatClient instance.

build(ConfigFetcher, ConfigCache) - Method in class com.configcat.LazyLoadingPolicy.Builder

Builds the configured LazyLoadingPolicy instance.

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

Builds the configured User instance.

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

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

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

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

C

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

Sets the internal cache implementation.

cache() - Method in class com.configcat.RefreshPolicy

Through this getter, child classes can use the cache to control the cached configuration.

cacheRefreshIntervalInSeconds(int) - Method in class com.configcat.LazyLoadingPolicy.Builder

Sets how long the cache will store its value before fetching the latest from the network again.

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

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

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

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

com.configcat - package com.configcat

config() - Method in class com.configcat.FetchResponse

Gets the fetched configuration value, should be used when the response has a FetchResponse.Status.FETCHED status code.

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(String) - Constructor for class com.configcat.ConfigCatClient

Constructs a new client instance with the default configuration.

ConfigCatClient.Builder - Class in com.configcat

A builder that helps construct a ConfigCatClient instance.

ConfigFetcher - Class in com.configcat

This class is used by the internal ConfigCache implementation to fetch the latest configuration.

configurationChangeListener(ConfigurationChangeListener) - Method in class com.configcat.AutoPollingPolicy.Builder

Sets a configuration changed listener.

ConfigurationChangeListener - Interface in com.configcat

The interface which's implementors can used to subscribe to the configuration changed event on AutoPollingPolicy.

ConfigurationParser - Class in com.configcat

A json parser which can be used to deserialize configuration json strings.

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

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.

E

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

Optional.

F

fetcher() - Method in class com.configcat.RefreshPolicy

Through this getter, child classes can use the fetcher to get the latest configuration over HTTP.

FetchResponse - Class in com.configcat

This class represents a fetch response object.

FetchResponse.Status - Enum in com.configcat

The response status, can be FETCHED, NOTMODIFIED or FAILED.

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() - Method in class com.configcat.ConfigCache

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

getAllKeys(String) - Method in class com.configcat.ConfigurationParser

Gets all setting keys from the config json.

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.

getConfigurationJsonAsync() - Method in class com.configcat.AutoPollingPolicy

getConfigurationJsonAsync() - Method in class com.configcat.LazyLoadingPolicy

getConfigurationJsonAsync() - Method in class com.configcat.ManualPollingPolicy

getConfigurationJsonAsync() - Method in class com.configcat.RefreshPolicy

Child classes has to implement this method, the ConfigCatClient uses it to read the current configuration value through the applied policy.

getConfigurationJsonStringAsync() - Method in class com.configcat.ConfigFetcher

Gets the latest configuration from the network asynchronously.

getInnerException() - Method in exception com.configcat.ParsingFailedException

Gets the inner exception.

getJson() - Method in exception com.configcat.ParsingFailedException

Gets the json string which was failed to parse.

getRefreshPolicy(Class<T>) - Method in class com.configcat.ConfigCatClient

getRefreshPolicy(Class<T>) - Method in interface com.configcat.ConfigurationProvider

Gets the internal refresh policy.

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 a value synchronously as T from the configuration identified by the given key.

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

Gets a value synchronously as T from the configuration identified by the given key.

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 a value asynchronously as T from the configuration identified by the given key.

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

Gets a value asynchronously as T from the configuration identified by the given key.

H

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

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

I

InMemoryConfigCache - Class in com.configcat

An in-memory cache implementation used to store the fetched configurations.

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

inMemoryValue() - Method in class com.configcat.ConfigCache

Through this getter, the in-memory representation of the cached value can be accessed.

isFailed() - Method in class com.configcat.FetchResponse

Gets whether the fetch failed or not.

isFetched() - Method in class com.configcat.FetchResponse

Gets whether a new configuration value was fetched or not.

isNotModified() - Method in class com.configcat.FetchResponse

Gets whether the fetch resulted a '304 Not Modified' or not.

L

LazyLoadingPolicy - Class in com.configcat

Describes a RefreshPolicy which uses an expiring cache to maintain the internally stored configuration.

LazyLoadingPolicy.Builder - Class in com.configcat

A builder that helps construct a LazyLoadingPolicy instance.

LOGGER - Static variable in class com.configcat.ConfigCache

M

ManualPollingPolicy - Class in com.configcat

Describes a RefreshPolicy which fetches the latest configuration over HTTP every time when a get is called on the ConfigCatClient.

ManualPollingPolicy(ConfigFetcher, ConfigCache) - Constructor for class com.configcat.ManualPollingPolicy

Constructor used by the child classes.

maxWaitTimeForSyncCallsInSeconds(int) - Method in class com.configcat.ConfigCatClient.Builder

Sets the maximum time in seconds at most how long the synchronous calls e.g.

N

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

Creates a new builder instance.

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

Creates a new builder instance.

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

Creates a new builder instance.

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

Creates a new builder instance.

O

onConfigurationChanged(ConfigurationParser, String) - Method in interface com.configcat.ConfigurationChangeListener

This method will be called when a configuration changed event fired.

P

parseValue(Class<T>, String, String) - Method in class com.configcat.ConfigurationParser

Parses a json element identified by the key from the given json string into a primitive type (Boolean, Double, Integer or String).

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

Parses a json element identified by the key from the given json string into a primitive type (Boolean, Double, Integer or String).

ParsingFailedException - Exception in com.configcat

Represents an exception which is being thrown when the parsing of a given json fails.

ParsingFailedException(String, String, Exception) - Constructor for exception com.configcat.ParsingFailedException

Constructs a parse exception object.

R

read() - 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.

read() - Method in class com.configcat.InMemoryConfigCache

refreshAsync() - Method in class com.configcat.RefreshPolicy

Initiates a force refresh on the cached configuration.

refreshPolicy(BiFunction<ConfigFetcher, ConfigCache, RefreshPolicy>) - Method in class com.configcat.ConfigCatClient.Builder

Sets the internal refresh policy implementation.

RefreshPolicy - Class in com.configcat

The public interface of a refresh policy which's implementors should describe the configuration update rules.

RefreshPolicy(ConfigFetcher, ConfigCache) - Constructor for class com.configcat.RefreshPolicy

Constructor used by the child classes.

removeConfigurationChangeListener(ConfigurationChangeListener) - Method in class com.configcat.AutoPollingPolicy

Removes a given listener from the configuration changed event.

S

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

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.FetchResponse.Status

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

values() - Static method in enum com.configcat.FetchResponse.Status

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

W

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

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

write(String) - Method in class com.configcat.InMemoryConfigCache

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