|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.google.common.cache.AbstractCache<K,V>
@Beta @GwtCompatible public abstract class AbstractCache<K,V>
This class provides a skeletal implementation of the Cache interface to minimize the
effort required to implement this interface.
To implement a cache, the programmer needs only to extend this class and provide an
implementation for the Cache.getIfPresent(K) method. getAllPresent(java.lang.Iterable extends K>) is implemented in
terms of getIfPresent; invalidateAll(Iterable) is implemented in terms of
invalidate(java.lang.Object). The method cleanUp() is a no-op. All other methods throw an
UnsupportedOperationException.
| Nested Class Summary | |
|---|---|
static class |
AbstractCache.SimpleStatsCounter
A thread-safe AbstractCache.StatsCounter implementation for use by Cache implementors. |
static interface |
AbstractCache.StatsCounter
Accumulates statistics during the operation of a Cache for presentation by Cache.stats(). |
| Constructor Summary | |
|---|---|
protected |
AbstractCache()
Constructor for use by subclasses. |
| Method Summary | |
|---|---|
V |
apply(K key)
Deprecated. |
ConcurrentMap<K,V> |
asMap()
Returns a view of the entries stored in this cache as a thread-safe map. |
void |
cleanUp()
Performs any pending maintenance operations needed by the cache. |
V |
get(K key,
Callable<? extends V> valueLoader)
Returns the value associated with key in this cache, obtaining that value from
valueLoader if necessary. |
ImmutableMap<K,V> |
getAllPresent(Iterable<? extends K> keys)
Returns a map of the values associated with keys in this cache. |
V |
getUnchecked(K key)
Deprecated. |
void |
invalidate(Object key)
Discards any cached value for key key. |
void |
invalidateAll()
Discards all entries in the cache. |
void |
invalidateAll(Iterable<?> keys)
Discards any cached values for keys keys. |
void |
put(K key,
V value)
Associates value with key in this cache. |
long |
size()
Returns the approximate number of entries in this cache. |
CacheStats |
stats()
Returns a current snapshot of this cache's cumulative statistics. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface com.google.common.cache.Cache |
|---|
get, getIfPresent |
| Methods inherited from interface com.google.common.base.Function |
|---|
equals |
| Constructor Detail |
|---|
protected AbstractCache()
| Method Detail |
|---|
public V get(K key,
Callable<? extends V> valueLoader)
throws ExecutionException
Cachekey in this cache, obtaining that value from
valueLoader if necessary. No observable state associated with this cache is modified
until loading completes. This method provides a simple substitute for the conventional
"if cached, return; otherwise create, cache and return" pattern.
Warning: as with CacheLoader.load(K), valueLoader must not return
null; it may either return a non-null value or throw an exception.
get in interface Cache<K,V>ExecutionException - if a checked exception was thrown while loading the valuepublic ImmutableMap<K,V> getAllPresent(Iterable<? extends K> keys)
Cachekeys in this cache. The returned map will
only contain entries which are already present in the cache.
getAllPresent in interface Cache<K,V>
public void put(K key,
V value)
Cachevalue with key in this cache. If the cache previously contained a
value associated with key, the old value is replaced by value.
Prefer #get(K, Callable) when using the conventional "if cached, return; otherwise
create, cache and return" pattern.
put in interface Cache<K,V>public void cleanUp()
Cache
cleanUp in interface Cache<K,V>public long size()
Cache
size in interface Cache<K,V>public void invalidate(Object key)
Cachekey.
invalidate in interface Cache<K,V>public void invalidateAll(Iterable<?> keys)
Cachekeys.
invalidateAll in interface Cache<K,V>public void invalidateAll()
Cache
invalidateAll in interface Cache<K,V>public CacheStats stats()
Cache
stats in interface Cache<K,V>public ConcurrentMap<K,V> asMap()
Cache
asMap in interface Cache<K,V>@Deprecated public V getUnchecked(K key)
Cachekey in this cache, first loading that value if
necessary. No observable state associated with this cache is modified until computation
completes. Unlike Cache.get(K, java.util.concurrent.Callable extends V>), this method does not throw a checked exception, and thus should
only be used in situations where checked exceptions are not thrown by the cache loader.
Warning: this method silently converts checked exceptions to unchecked exceptions, and should not be used with cache loaders which throw checked exceptions.
getUnchecked in interface Cache<K,V>@Deprecated public V apply(K key)
CacheFunction interface; use Cache.get(K, java.util.concurrent.Callable extends V>) or
Cache.getUnchecked(K) instead.
apply in interface Function<K,V>apply in interface Cache<K,V>
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||