in.srain.cube.cache

Interface ICacheAble<T>

All Known Subinterfaces:

ICacheAbleRequest<T>

All Known Implementing Classes:

CacheAbleRequest, Query

public interface ICacheAble<T>

Describe the behaviour of a object who can be cached

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cacheIsDisabled() check if cache is disabled
java.lang.String	getAssertInitDataPath()
java.lang.String	getCacheKey()
long	getCacheTime() In seconds
void	onCacheData(CacheResultType cacheResultType, T cacheData, boolean outOfDate) when data loaded from cache
void	onNoCacheData(CacheManager cacheManager) When there is no cache data is available, this method will be called.
T	processRawDataFromCache(JsonData rawData) We need to process the data from data source, do some filter of convert the structure.
ICacheAble<T>	setAssertInitDataPath(java.lang.String path)
ICacheAble<T>	setCacheKey(java.lang.String key)
ICacheAble<T>	setCacheTime(long time) set cache time, in seconds
ICacheAble<T>	setDisableCache(boolean disable) temporarily disable cache.
ICacheAble<T>	setUseCacheAnyway(boolean use) Using cache data if existent, ignore whether it is expired or not.
boolean	useCacheAnyway() check if use cache anyway

Method Detail

setCacheTime

ICacheAble<T> setCacheTime(long time)

set cache time, in seconds

Parameters:

time -

Returns:

getCacheTime

long getCacheTime()

In seconds

Returns:

setCacheKey

ICacheAble<T> setCacheKey(java.lang.String key)

getCacheKey

java.lang.String getCacheKey()

setUseCacheAnyway

ICacheAble<T> setUseCacheAnyway(boolean use)

Using cache data if existent, ignore whether it is expired or not.

Parameters:

use -

useCacheAnyway

boolean useCacheAnyway()

check if use cache anyway

Returns:

setAssertInitDataPath

ICacheAble<T> setAssertInitDataPath(java.lang.String path)

Parameters:

path - file path under /res, For example: "/cache_init/test.json";

Returns:

getAssertInitDataPath

java.lang.String getAssertInitDataPath()

Returns:

file path under /res, For example: "/cache_init/test.json";

processRawDataFromCache

T processRawDataFromCache(JsonData rawData)

We need to process the data from data source, do some filter of convert the structure.

As the "Assert Data" is a special data source, we also need to do the same work.

onCacheData

void onCacheData(CacheResultType cacheResultType,
               T cacheData,
               boolean outOfDate)

when data loaded from cache

Parameters:

cacheData -

outOfDate -

onNoCacheData

void onNoCacheData(CacheManager cacheManager)

When there is no cache data is available, this method will be called. Will always in Main UI thread

setDisableCache

ICacheAble<T> setDisableCache(boolean disable)

temporarily disable cache. The data will no be load from cache and will also not be put into cache

cacheIsDisabled

boolean cacheIsDisabled()

check if cache is disabled

Returns: