Class BoundedLocalCache.BoundedPolicy.BoundedVarExpiration

java.lang.Object
com.github.benmanes.caffeine.cache.BoundedLocalCache.BoundedPolicy.BoundedVarExpiration
All Implemented Interfaces:
Policy.VarExpiration<K,V>
Enclosing class:
BoundedLocalCache.BoundedPolicy<K,V>
final class BoundedLocalCache.BoundedPolicy.BoundedVarExpiration extends Object implements Policy.VarExpiration<K,V>

  • Constructor Details

    • BoundedVarExpiration

      BoundedVarExpiration()

  • Method Details

    • getExpiresAfter

      public OptionalLong getExpiresAfter(K key, TimeUnit unit)
      Description copied from interface: Policy.VarExpiration
      Returns the duration until the entry should be automatically removed. The expiration policy determines when the entry's duration is reset.

      This method is scheduled for removal in version 3.0.0.

      Specified by:
      getExpiresAfter in interface Policy.VarExpiration<K,V>
      Parameters:
      key - the key for the entry being queried
      unit - the unit that age is expressed in
      Returns:
      the duration if the entry is present in the cache

    • setExpiresAfter

      public void setExpiresAfter(K key, long duration, TimeUnit unit)
      Description copied from interface: Policy.VarExpiration
      Specifies that the entry should be automatically removed from the cache once the duration has elapsed. The expiration policy determines when the entry's age is reset.
      Specified by:
      setExpiresAfter in interface Policy.VarExpiration<K,V>
      Parameters:
      key - the key for the entry being set
      duration - the length of time from now when the entry should be automatically removed
      unit - the unit that duration is expressed in

    • put

      public void put(K key, V value, long duration, TimeUnit unit)
      Description copied from interface: Policy.VarExpiration
      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. This method differs from Cache.put(K, V) by substituting the configured Expiry with the specified write duration.

      This method is scheduled for removal in version 3.0.0.

      Specified by:
      put in interface Policy.VarExpiration<K,V>
      Parameters:
      key - the key with which the specified value is to be associated
      value - value to be associated with the specified key
      duration - the length of time from now when the entry should be automatically removed
      unit - the unit that duration is expressed in

    • putIfAbsent

      public boolean putIfAbsent(K key, V value, long duration, TimeUnit unit)
      Description copied from interface: Policy.VarExpiration
      Associates the value with the key in this cache if the specified key is not already associated with a value. This method differs from Map.putIfAbsent(K, V) by substituting the configured Expiry with the specified write duration, has no effect on the duration if the entry was present, and returns the success rather than a value.

      This method is scheduled for removal in version 3.0.0.

      Specified by:
      putIfAbsent in interface Policy.VarExpiration<K,V>
      Parameters:
      key - the key with which the specified value is to be associated
      value - value to be associated with the specified key
      duration - the length of time from now when the entry should be automatically removed
      unit - the unit that duration is expressed in
      Returns:
      true if this cache did not already contain the specified entry

    • put

      @Nullable V put(K key, V value, long duration, TimeUnit unit, boolean onlyIfAbsent)

    • oldest

      public Map<K,V> oldest(int limit)
      Description copied from interface: Policy.VarExpiration
      Returns an unmodifiable snapshot Map view of the cache with ordered traversal. The order of iteration is from the entries most likely to expire (oldest) to the entries least likely to expire (youngest). This order is determined by the expiration policy's best guess at the time of creating this snapshot view.

      Beware that obtaining the mappings is NOT a constant-time operation. Because of the asynchronous nature of the page replacement policy, determining the retention ordering requires a traversal of the entries.

      Specified by:
      oldest in interface Policy.VarExpiration<K,V>
      Parameters:
      limit - the maximum size of the returned map (use Integer.MAX_VALUE to disregard the limit)
      Returns:
      a snapshot view of the cache from oldest entry to the youngest

    • youngest

      public Map<K,V> youngest(int limit)
      Description copied from interface: Policy.VarExpiration
      Returns an unmodifiable snapshot Map view of the cache with ordered traversal. The order of iteration is from the entries least likely to expire (youngest) to the entries most likely to expire (oldest). This order is determined by the expiration policy's best guess at the time of creating this snapshot view.

      Beware that obtaining the mappings is NOT a constant-time operation. Because of the asynchronous nature of the page replacement policy, determining the retention ordering requires a traversal of the entries.

      Specified by:
      youngest in interface Policy.VarExpiration<K,V>
      Parameters:
      limit - the maximum size of the returned map (use Integer.MAX_VALUE to disregard the limit)
      Returns:
      a snapshot view of the cache from youngest entry to the oldest