Interface LocalAsyncCache<K,V>

All Superinterfaces:
AsyncCache<K,V>
All Known Implementing Classes:
BoundedLocalCache.BoundedLocalAsyncCache, BoundedLocalCache.BoundedLocalAsyncLoadingCache, LocalAsyncLoadingCache, UnboundedLocalCache.UnboundedLocalAsyncCache, UnboundedLocalCache.UnboundedLocalAsyncLoadingCache
interface LocalAsyncCache<K,V> extends AsyncCache<K,V>
This class provides a skeletal implementation of the AsyncCache interface to minimize the effort required to implement a LocalCache.

  • Field Details

    • logger

      static final Logger logger

  • Method Details

    • cache

      LocalCache<K, CompletableFuture<V>> cache()
      Returns the backing LocalCache data store.

    • policy

      Policy<K,V> policy()
      Returns the policy supported by this implementation and its configuration.

    • getIfPresent

      default @Nullable CompletableFuture<V> getIfPresent(@NonNull Object key)
      Description copied from interface: AsyncCache
      Returns the future associated with key in this cache, or null if there is no cached future for key.
      Specified by:
      getIfPresent in interface AsyncCache<K,V>
      Parameters:
      key - key whose associated value is to be returned
      Returns:
      the current (existing or computed) future value to which the specified key is mapped, or null if this cache contains no mapping for the key

    • get

      default CompletableFuture<V> get(@NonNull K key, @NonNull Function<? super K, ? extends V> mappingFunction)
      Description copied from interface: AsyncCache
      Returns the future associated with key in this cache, obtaining that value from 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 asynchronously 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. If the asynchronous computation fails, the entry will be automatically removed from 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 AsyncCache<K,V>
      Parameters:
      key - key with which the specified value is to be associated
      mappingFunction - the function to asynchronously compute a value
      Returns:
      the current (existing or computed) future value associated with the specified key

    • get

      default CompletableFuture<V> get(K key, BiFunction<? super K, Executor, CompletableFuture<V>> mappingFunction)
      Description copied from interface: AsyncCache
      Returns the future associated with key in this cache, obtaining that value from 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 asynchronously 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. If the asynchronous computation fails, the entry will be automatically removed from 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 AsyncCache<K,V>
      Parameters:
      key - key with which the specified value is to be associated
      mappingFunction - the function to asynchronously compute a value
      Returns:
      the current (existing or computed) future value associated with the specified key

    • get

      default CompletableFuture<V> get(K key, BiFunction<? super K, Executor, CompletableFuture<V>> mappingFunction, boolean recordStats)

    • getAll

      default CompletableFuture<Map<K,V>> getAll(Iterable<? extends @NonNull K> keys, Function<Iterable<? extends K>, Map<K,V>> mappingFunction)
      Description copied from interface: AsyncCache
      Returns the future of a map of the values associated with keys, creating or retrieving those values if necessary. The returned map contains entries that were already cached, combined with newly loaded entries; it will never contain null keys or values. If the any of the asynchronous computations fail, those entries will be automatically removed from this cache.

      A single request to the mappingFunction is performed for all keys which are not already present in the cache. If another call to AsyncCache.get(K, Function) tries to load the value for a key in keys, that thread retrieves a future that is completed by this bulk computation. Any loaded values for keys that were not specifically requested will not be returned, but will be stored in the cache. Note that multiple threads can concurrently load values for distinct keys.

      Note that duplicate elements in keys, as determined by Object.equals(Object), will be ignored.

      Specified by:
      getAll in interface AsyncCache<K,V>
      Parameters:
      keys - the keys whose associated values are to be returned
      mappingFunction - the function to asynchronously compute the values
      Returns:
      the future containing an unmodifiable mapping of keys to values for the specified keys in this cache

    • getAll

      default CompletableFuture<Map<K,V>> getAll(Iterable<? extends @NonNull K> keys, BiFunction<Iterable<? extends K>, Executor, CompletableFuture<Map<K,V>>> mappingFunction)
      Description copied from interface: AsyncCache
      Returns the future of a map of the values associated with keys, creating or retrieving those values if necessary. The returned map contains entries that were already cached, combined with newly loaded entries; it will never contain null keys or values. If the any of the asynchronous computations fail, those entries will be automatically removed from this cache.

      A single request to the mappingFunction is performed for all keys which are not already present in the cache. If another call to AsyncCache.get(K, Function) tries to load the value for a key in keys, that thread retrieves a future that is completed by this bulk computation. Any loaded values for keys that were not specifically requested will not be returned, but will be stored in the cache. Note that multiple threads can concurrently load values for distinct keys.

      Note that duplicate elements in keys, as determined by Object.equals(Object), will be ignored.

      Specified by:
      getAll in interface AsyncCache<K,V>
      Parameters:
      keys - the keys whose associated values are to be returned
      mappingFunction - the function to asynchronously compute the values
      Returns:
      the future containing an unmodifiable mapping of keys to values for the specified keys in this cache

    • composeResult

      default CompletableFuture<Map<K,V>> composeResult(Map<K, CompletableFuture<V>> futures)
      Returns a future that waits for all of the dependent futures to complete and returns the combined mapping if successful. If any future fails then it is automatically removed from the cache if still present.

    • put

      default void put(K key, CompletableFuture<V> valueFuture)
      Description copied from interface: AsyncCache
      Associates value with key in this cache. If the cache previously contained a value associated with key, the old value is replaced by value. If the asynchronous computation fails, the entry will be automatically removed.

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

      Specified by:
      put in interface AsyncCache<K,V>
      Parameters:
      key - key with which the specified value is to be associated
      valueFuture - value to be associated with the specified key

    • handleCompletion

      default void handleCompletion(K key, CompletableFuture<V> valueFuture, long startTime, boolean recordMiss)