Package com.google.common.cache

Class ForwardingCache<K,​V>

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.concurrent.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, java.util.concurrent.Callable<? extends V> valueLoader)
      Returns the value associated with key in this cache, obtaining that value from valueLoader if necessary.
      ImmutableMap<K,​V> getAllPresent​(java.lang.Iterable<?> keys)
      Returns a map of the values associated with keys in this cache.
      V getIfPresent​(java.lang.Object key)
      Returns the value associated with key in this cache, or null if there is no cached value for key.
      void invalidate​(java.lang.Object key)
      Discards any cached value for key key.
      void invalidateAll()
      Discards all entries in the cache.
      void invalidateAll​(java.lang.Iterable<?> keys)
      Discards any cached values for keys keys.
      void put​(K key, V value)
      Associates value with key in this cache.
      void putAll​(java.util.Map<? extends K,​? extends V> m)
      Copies all of the mappings from the specified map to the 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

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Method Detail

      • getIfPresent

        @Nullable
public V getIfPresent​(java.lang.Object key)
        Description copied from interface: Cache
        Returns the value associated with key in this cache, or null if there is no cached value for key.
        Specified by:
        getIfPresent in interface Cache<K,​V>
        Since:
        11.0

      • get

        public V get​(K key,
             java.util.concurrent.Callable<? extends V> valueLoader)
      throws java.util.concurrent.ExecutionException
        Description copied from interface: Cache
        Returns the value associated with key 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.

        Specified by:
        get in interface Cache<K,​V>
        Throws:
        java.util.concurrent.ExecutionException - if a checked exception was thrown while loading the value
        Since:
        11.0

      • getAllPresent

        public ImmutableMap<K,​V> getAllPresent​(java.lang.Iterable<?> keys)
        Description copied from interface: Cache
        Returns a map of the values associated with keys in this cache. The returned map will only contain entries which are already present in the cache.
        Specified by:
        getAllPresent in interface Cache<K,​V>
        Since:
        11.0

      • put

        public void put​(K key,
                V value)
        Description copied from interface: Cache
        Associates value with key in this cache. If the cache previously contained a value associated with key, the old value is replaced by value.

        Prefer Cache.get(Object, Callable) when using the conventional "if cached, return; otherwise create, cache and return" pattern.

        Specified by:
        put in interface Cache<K,​V>
        Since:
        11.0

      • putAll

        public void putAll​(java.util.Map<? extends K,​? extends V> m)
        Description copied from interface: Cache
        Copies all of the mappings from the specified map to the cache. The effect of this call is equivalent to that of calling put(k, v) on this map once for each mapping from key k to value v in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress.
        Specified by:
        putAll in interface Cache<K,​V>
        Since:
        12.0

      • invalidate

        public void invalidate​(java.lang.Object key)
        Description copied from interface: Cache
        Discards any cached value for key key.
        Specified by:
        invalidate in interface Cache<K,​V>

      • invalidateAll

        public void invalidateAll​(java.lang.Iterable<?> keys)
        Description copied from interface: Cache
        Discards any cached values for keys keys.
        Specified by:
        invalidateAll in interface Cache<K,​V>
        Since:
        11.0

      • invalidateAll

        public void invalidateAll()
        Description copied from interface: Cache
        Discards all entries in the cache.
        Specified by:
        invalidateAll in interface Cache<K,​V>

      • size

        public long size()
        Description copied from interface: Cache
        Returns the approximate number of entries in this cache.
        Specified by:
        size in interface Cache<K,​V>

      • stats

        public CacheStats stats()
        Description copied from interface: Cache
        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.
        Specified by:
        stats in interface Cache<K,​V>

      • asMap

        public java.util.concurrent.ConcurrentMap<K,​V> asMap()
        Description copied from interface: Cache
        Returns a view of the entries stored in this cache as a thread-safe map. Modifications made to the map directly affect the cache.
        Specified by:
        asMap in interface Cache<K,​V>

      • cleanUp

        public void cleanUp()
        Description copied from interface: Cache
        Performs any pending maintenance operations needed by the cache. Exactly which activities are performed -- if any -- is implementation-dependent.
        Specified by:
        cleanUp in interface Cache<K,​V>