Package com.google.common.cache
Interface Cache<K,V>
-
- All Known Subinterfaces:
LoadingCache<K,V>
- All Known Implementing Classes:
AbstractCache
,AbstractLoadingCache
,ForwardingCache
,ForwardingCache.SimpleForwardingCache
,ForwardingLoadingCache
,ForwardingLoadingCache.SimpleForwardingLoadingCache
@Beta @GwtCompatible @Deprecated(since="2022-12-01") public interface Cache<K,V>
Deprecated.The Google Guava Core Libraries are deprecated and will not be part of the AEM SDK after April 2023A semi-persistent mapping from keys to values. Cache entries are manually added usingget(Object, Callable)
orput(Object, Object)
, and are stored in the cache until either evicted or manually invalidated.Implementations of this interface are expected to be thread-safe, and can be safely accessed by multiple concurrent threads.
Note that while this class is still annotated as
Beta
, the API is frozen from a consumer's standpoint. In other words existing methods are all considerednon-Beta
and won't be changed without going through an 18 month deprecation cycle; however new methods may be added at any time.- Since:
- 10.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description java.util.concurrent.ConcurrentMap<K,V>
asMap()
Deprecated.Returns a view of the entries stored in this cache as a thread-safe map.void
cleanUp()
Deprecated.Performs any pending maintenance operations needed by the cache.V
get(K key, java.util.concurrent.Callable<? extends V> valueLoader)
Deprecated.Returns the value associated withkey
in this cache, obtaining that value fromvalueLoader
if necessary.ImmutableMap<K,V>
getAllPresent(java.lang.Iterable<?> keys)
Deprecated.Returns a map of the values associated withkeys
in this cache.V
getIfPresent(java.lang.Object key)
Deprecated.Returns the value associated withkey
in this cache, ornull
if there is no cached value forkey
.void
invalidate(java.lang.Object key)
Deprecated.Discards any cached value for keykey
.void
invalidateAll()
Deprecated.Discards all entries in the cache.void
invalidateAll(java.lang.Iterable<?> keys)
Deprecated.Discards any cached values for keyskeys
.void
put(K key, V value)
Deprecated.Associatesvalue
withkey
in this cache.void
putAll(java.util.Map<? extends K,? extends V> m)
Deprecated.Copies all of the mappings from the specified map to the cache.long
size()
Deprecated.Returns the approximate number of entries in this cache.CacheStats
stats()
Deprecated.Returns a current snapshot of this cache's cumulative statistics.
-
-
-
Method Detail
-
getIfPresent
@Nullable V getIfPresent(java.lang.Object key)
Deprecated.Returns the value associated withkey
in this cache, ornull
if there is no cached value forkey
.- Since:
- 11.0
-
get
V get(K key, java.util.concurrent.Callable<? extends V> valueLoader) throws java.util.concurrent.ExecutionException
Deprecated.Returns the value associated withkey
in this cache, obtaining that value fromvalueLoader
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 returnnull
; it may either return a non-null value or throw an exception.- Throws:
java.util.concurrent.ExecutionException
- if a checked exception was thrown while loading the valueUncheckedExecutionException
- if an unchecked exception was thrown while loading the valueExecutionError
- if an error was thrown while loading the value- Since:
- 11.0
-
getAllPresent
ImmutableMap<K,V> getAllPresent(java.lang.Iterable<?> keys)
Deprecated.Returns a map of the values associated withkeys
in this cache. The returned map will only contain entries which are already present in the cache.- Since:
- 11.0
-
put
void put(K key, V value)
Deprecated.Associatesvalue
withkey
in this cache. If the cache previously contained a value associated withkey
, the old value is replaced byvalue
.Prefer
get(Object, Callable)
when using the conventional "if cached, return; otherwise create, cache and return" pattern.- Since:
- 11.0
-
putAll
void putAll(java.util.Map<? extends K,? extends V> m)
Deprecated.Copies 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 keyk
to valuev
in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress.- Since:
- 12.0
-
invalidate
void invalidate(java.lang.Object key)
Deprecated.Discards any cached value for keykey
.
-
invalidateAll
void invalidateAll(java.lang.Iterable<?> keys)
Deprecated.Discards any cached values for keyskeys
.- Since:
- 11.0
-
invalidateAll
void invalidateAll()
Deprecated.Discards all entries in the cache.
-
size
long size()
Deprecated.Returns the approximate number of entries in this cache.
-
stats
CacheStats stats()
Deprecated.Returns a current snapshot of this cache's cumulative statistics. All stats are initialized to zero, and are monotonically increasing over the lifetime of the cache.
-
asMap
java.util.concurrent.ConcurrentMap<K,V> asMap()
Deprecated.Returns a view of the entries stored in this cache as a thread-safe map. Modifications made to the map directly affect the cache.
-
cleanUp
void cleanUp()
Deprecated.Performs any pending maintenance operations needed by the cache. Exactly which activities are performed -- if any -- is implementation-dependent.
-
-