Package com.github.benmanes.caffeine.cache

Interface LocalManualCache<C extends LocalCache<K,​V>,​K,​V>

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default java.util.concurrent.ConcurrentMap<K,​V> asMap()
      Returns a view of the entries stored in this cache as a thread-safe map.
      C cache()
      Returns the backing LocalCache data store.
      default void cleanUp()
      Performs any pending maintenance operations needed by the cache.
      default long estimatedSize()
      Returns the approximate number of entries in this cache.
      default V get​(K key, java.util.function.Function<? super K,​? extends V> mappingFunction)
      Returns the value associated with the key in this cache, obtaining that value from the mappingFunction if necessary.
      default java.util.Map<K,​V> getAllPresent​(java.lang.Iterable<?> keys)
      Returns a map of the values associated with the keys in this cache.
      default V getIfPresent​(java.lang.Object key)
      Returns the value associated with the key in this cache, or null if there is no cached value for the key.
      default void invalidate​(java.lang.Object key)
      Discards any cached value for the key.
      default void invalidateAll()
      Discards all entries in the cache.
      default void invalidateAll​(java.lang.Iterable<?> keys)
      Discards any cached values for the keys.
      default void put​(K key, V value)
      Associates the value with the key in this cache.
      default void putAll​(java.util.Map<? extends K,​? extends V> map)
      Copies all of the mappings from the specified map to the cache.
      default CacheStats stats()
      Returns a current snapshot of this cache's cumulative statistics.

      • Methods inherited from interface com.github.benmanes.caffeine.cache.Cache

        policy

    • Method Detail

      • cache

        C cache()
        Returns the backing LocalCache data store.

      • estimatedSize

        default long estimatedSize()
        Description copied from interface: Cache
        Returns the approximate number of entries in this cache. The value returned is an estimate; the actual count may differ if there are concurrent insertions or removals, or if some entries are pending removal due to expiration or weak/soft reference collection. In the case of stale entries this inaccuracy can be mitigated by performing a Cache.cleanUp() first.
        Specified by:
        estimatedSize in interface Cache<C extends LocalCache<K,​V>,​K>
        Returns:
        the estimated number of mappings

      • cleanUp

        default 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<C extends LocalCache<K,​V>,​K>

      • getIfPresent

        @Nullable
default V getIfPresent​(java.lang.Object key)
        Description copied from interface: Cache
        Returns the value associated with the key in this cache, or null if there is no cached value for the key.
        Specified by:
        getIfPresent in interface Cache<C extends LocalCache<K,​V>,​K>
        Parameters:
        key - the key whose associated value is to be returned
        Returns:
        the value to which the specified key is mapped, or null if this map contains no mapping for the key

      • get

        default V get​(K key,
              java.util.function.Function<? super K,​? extends V> mappingFunction)
        Description copied from interface: Cache
        Returns the value associated with the key in this cache, obtaining that value from the mappingFunction if necessary. This method provides a simple substitute for the conventional "if cached, return; otherwise create, cache and return" pattern.

        If the specified key is not already associated with a value, attempts to compute its value using the given mapping function and enters it into this cache unless null. The entire method invocation is performed atomically, so the function is applied at most once per key. Some attempted update operations on this cache by other threads may be blocked while the computation is in progress, so the computation should be short and simple, and must not attempt to update any other mappings of this cache.

        Warning: as with CacheLoader.load(K), mappingFunction must not attempt to update any other mappings of this cache.

        Specified by:
        get in interface Cache<C extends LocalCache<K,​V>,​K>
        Parameters:
        key - the key with which the specified value is to be associated
        mappingFunction - the function to compute a value
        Returns:
        the current (existing or computed) value associated with the specified key, or null if the computed value is null

      • getAllPresent

        default java.util.Map<K,​V> getAllPresent​(java.lang.Iterable<?> keys)
        Description copied from interface: Cache
        Returns a map of the values associated with the keys in this cache. The returned map will only contain entries which are already present in the cache.
        Specified by:
        getAllPresent in interface Cache<C extends LocalCache<K,​V>,​K>
        Parameters:
        keys - the keys whose associated values are to be returned
        Returns:
        the unmodifiable mapping of keys to values for the specified keys found in this cache

      • put

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

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

        Specified by:
        put in interface Cache<C extends LocalCache<K,​V>,​K>
        Parameters:
        key - the key with which the specified value is to be associated
        value - value to be associated with the specified key

      • putAll

        default void putAll​(java.util.Map<? extends K,​? extends V> map)
        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<C extends LocalCache<K,​V>,​K>
        Parameters:
        map - the mappings to be stored in this cache

      • invalidate

        default void invalidate​(java.lang.Object key)
        Description copied from interface: Cache
        Discards any cached value for the key. The behavior of this operation is undefined for an entry that is being loaded and is otherwise not present.
        Specified by:
        invalidate in interface Cache<C extends LocalCache<K,​V>,​K>
        Parameters:
        key - the key whose mapping is to be removed from the cache

      • invalidateAll

        default void invalidateAll​(java.lang.Iterable<?> keys)
        Description copied from interface: Cache
        Discards any cached values for the keys. The behavior of this operation is undefined for an entry that is being loaded and is otherwise not present.
        Specified by:
        invalidateAll in interface Cache<C extends LocalCache<K,​V>,​K>
        Parameters:
        keys - the keys whose associated values are to be removed

      • invalidateAll

        default void invalidateAll()
        Description copied from interface: Cache
        Discards all entries in the cache. The behavior of this operation is undefined for an entry that is being loaded and is otherwise not present.
        Specified by:
        invalidateAll in interface Cache<C extends LocalCache<K,​V>,​K>

      • stats

        default CacheStats stats()
        Description copied from interface: Cache
        Returns a current snapshot of this cache's cumulative statistics. All statistics are initialized to zero, and are monotonically increasing over the lifetime of the cache.

        Due to the performance penalty of maintaining statistics, some implementations may not record the usage history immediately or at all.

        Specified by:
        stats in interface Cache<C extends LocalCache<K,​V>,​K>
        Returns:
        the current snapshot of the statistics of this cache

      • asMap

        default 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.

        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.

        Specified by:
        asMap in interface Cache<C extends LocalCache<K,​V>,​K>
        Returns:
        a thread-safe view of this cache supporting all of the optional Map operations