Class LocalCache.LocalManualCache<K,V>
- All Implemented Interfaces:
Cache<K,,V> Serializable
- Direct Known Subclasses:
LocalCache.LocalLoadingCache
- Enclosing class:
LocalCache<K,V>
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) final LocalCache<K, V> private static final long -
Constructor Summary
ConstructorsModifierConstructorDescription(package private)LocalManualCache(CacheBuilder<? super K, ? super V> builder) privateLocalManualCache(LocalCache<K, V> localCache) -
Method Summary
Modifier and TypeMethodDescriptionasMap()Returns a view of the entries stored in this cache as a thread-safe map.voidcleanUp()Performs any pending maintenance operations needed by the cache.Returns the value associated withkeyin this cache, obtaining that value fromloaderif necessary.getAllPresent(Iterable<?> keys) Returns a map of the values associated withkeysin this cache.getIfPresent(Object key) Returns the value associated withkeyin this cache, ornullif there is no cached value forkey.voidinvalidate(Object key) Discards any cached value for keykey.voidDiscards all entries in the cache.voidinvalidateAll(Iterable<?> keys) Discards any cached values for keyskeys.voidAssociatesvaluewithkeyin this cache.voidCopies all of the mappings from the specified map to the cache.private voidlongsize()Returns the approximate number of entries in this cache.stats()Returns a current snapshot of this cache's cumulative statistics, or a set of default values if the cache is not recording statistics.(package private) Object
-
Field Details
-
localCache
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
-
Constructor Details
-
LocalManualCache
LocalManualCache(CacheBuilder<? super K, ? super V> builder) -
LocalManualCache
-
-
Method Details
-
getIfPresent
Description copied from interface:CacheReturns the value associated withkeyin this cache, ornullif there is no cached value forkey.- Specified by:
getIfPresentin interfaceCache<K,V>
-
get
Description copied from interface:CacheReturns the value associated withkeyin this cache, obtaining that value fromloaderif necessary. The method improves upon the conventional "if cached, return; otherwise create, cache and return" pattern. For further improvements, useLoadingCacheand itsget(K)method instead of this one.Among the improvements that this method and
LoadingCache.get(K)both provide are:- awaiting the result of a pending load rather than starting a redundant one
- eliminating the error-prone caching boilerplate
- tracking load statistics
Among the further improvements that
LoadingCachecan provide but this method cannot:- consolidation of the loader logic to a single authoritative location
- refreshing of entries, including automated refreshing
- bulk loading requests, including bulk loading implementations
Warning: For any given key, every
loaderused with it should compute the same value. Otherwise, a call that passes oneloadermay return the result of another call with a differently behavingloader. For example, a call that requests a short timeout for an RPC may wait for a similar call that requests a long timeout, or a call by an unprivileged user may return a resource accessible only to a privileged user making a similar call. To prevent this problem, create a key object that includes all values that affect the result of the query. Or useLoadingCache.get(K), which lacks the ability to refer to state other than that in the key.Warning: as with
CacheLoader.load(K),loadermust not returnnull; it may either return a non-null value or throw an exception.No observable state associated with this cache is modified until loading completes.
- Specified by:
getin interfaceCache<K,V> - Throws:
ExecutionException- if a checked exception was thrown while loading the value
-
getAllPresent
Description copied from interface:CacheReturns a map of the values associated withkeysin this cache. The returned map will only contain entries which are already present in the cache.- Specified by:
getAllPresentin interfaceCache<K,V>
-
put
Description copied from interface:CacheAssociatesvaluewithkeyin this cache. If the cache previously contained a value associated withkey, the old value is replaced byvalue.Prefer
Cache.get(Object, Callable)when using the conventional "if cached, return; otherwise create, cache and return" pattern. -
putAll
Description copied from interface:CacheCopies all of the mappings from the specified map to the cache. The effect of this call is equivalent to that of callingput(k, v)on this map once for each mapping from keykto valuevin the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress. -
invalidate
Description copied from interface:CacheDiscards any cached value for keykey.- Specified by:
invalidatein interfaceCache<K,V>
-
invalidateAll
Description copied from interface:CacheDiscards any cached values for keyskeys.- Specified by:
invalidateAllin interfaceCache<K,V>
-
invalidateAll
public void invalidateAll()Description copied from interface:CacheDiscards all entries in the cache.- Specified by:
invalidateAllin interfaceCache<K,V>
-
size
public long size()Description copied from interface:CacheReturns the approximate number of entries in this cache. -
asMap
Description copied from interface:CacheReturns a view of the entries stored in this cache as a thread-safe map. Modifications made to the map directly affect the cache.Iterators from the returned map are at least weakly consistent: they are safe for concurrent use, but if the cache is modified (including by eviction) after the iterator is created, it is undefined which of the changes (if any) will be reflected in that iterator.
-
stats
Description copied from interface:CacheReturns a current snapshot of this cache's cumulative statistics, or a set of default values if the cache is not recording statistics. All statistics begin at zero and never decrease over the lifetime of the cache.Warning: this cache may not be recording statistical data. For example, a cache created using
CacheBuilderonly does so if theCacheBuilder.recordStats()method was called. If statistics are not being recorded, aCacheStatsinstance with zero for all values is returned. -
cleanUp
public void cleanUp()Description copied from interface:CachePerforms any pending maintenance operations needed by the cache. Exactly which activities are performed -- if any -- is implementation-dependent. -
writeReplace
Object writeReplace() -
readObject
- Throws:
InvalidObjectException
-