com.configcat

Class ConfigCache

java.lang.Object

com.configcat.ConfigCache

public abstract class ConfigCache
extends java.lang.Object

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

Constructor Summary

Constructors

Constructor and Description
ConfigCache()

Method Summary

Modifier and Type	Method and Description
java.lang.String	get()
java.lang.String	inMemoryValue() Through this getter, the in-memory representation of the cached value can be accessed.
protected abstract java.lang.String	read() Child classes has to implement this method, the ConfigCatClient uses it to get the actual value from the cache.
void	set(java.lang.String value)
protected abstract void	write(java.lang.String value) * Child classes has to implement this method, the ConfigCatClient uses it to set the actual cached value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigCache

public ConfigCache()

Method Detail

get

public java.lang.String get()

set

public void set(java.lang.String value)

inMemoryValue

public java.lang.String inMemoryValue()

Through this getter, the in-memory representation of the cached value can be accessed. When the underlying cache implementations is not able to load or store its value, this will represent the latest cached configuration.

Returns:

the cached value in memory.

read

protected abstract java.lang.String read()
                                  throws java.lang.Exception

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

Returns:

the cached configuration.

Throws:

java.lang.Exception - if unable to read the cache.

write

protected abstract void write(java.lang.String value)
                       throws java.lang.Exception

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

Parameters:

value - the new value to cache.

Throws:

java.lang.Exception - if unable to save the value.