fiftyone.mobile.detection.cache

Interface ICache<K,V>

All Known Subinterfaces:

ILoadingCache<K,V>, IPutCache<K,V>

All Known Implementing Classes:

ICache.Base, LruCache

public interface ICache<K,V>

Interface for caches as used internally to the system

Aside from get(Object) methods are optional.

Implementations may choose to respond "-1" for methods that return numbers and proiver a no op for resetCache()

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ICache.Base<K,V>

Method Summary

Modifier and Type	Method and Description
V	get(K key)
long	getCacheMisses() The number of requests that could not be served
long	getCacheRequests() The number of requests made to the cache
long	getCacheSize() The size of the cache as number of entries
double	getPercentageMisses() a fraction < 1 (not a percentage) misses/requests
void	resetCache() Remove all entries from the cache and reset statistics if possible.

Method Detail

getCacheSize

long getCacheSize()

The size of the cache as number of entries

getCacheMisses

long getCacheMisses()

The number of requests that could not be served

getCacheRequests

long getCacheRequests()

The number of requests made to the cache

getPercentageMisses

double getPercentageMisses()

a fraction < 1 (not a percentage) misses/requests

get

V get(K key)

Parameters:

key - not null key to retrieve value

Returns:

null if value is not present

Throws:

IllegalStateException - if misoperation of underlying mechanisms

resetCache

void resetCache()

Remove all entries from the cache and reset statistics if possible.