Class PassiveExpiringMap.ConstantTimeToLiveExpirationPolicy<K,V>

java.lang.Object
org.apache.commons.collections4.map.PassiveExpiringMap.ConstantTimeToLiveExpirationPolicy<K,V>
Type Parameters:
K - the type of the keys in the map
V - the type of the values in the map
All Implemented Interfaces:
Serializable, PassiveExpiringMap.ExpirationPolicy<K,V>
Enclosing class:
PassiveExpiringMap<K,V>

public static class PassiveExpiringMap.ConstantTimeToLiveExpirationPolicy<K,V> extends Object implements PassiveExpiringMap.ExpirationPolicy<K,V>
A ExpirationPolicy that returns a expiration time that is a constant about of time in the future from the current time.
Since:
4.0
See Also:
  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      Serialization version
      See Also:
    • timeToLiveMillis

      private final long timeToLiveMillis
      the constant time-to-live value measured in milliseconds.
  • Constructor Details

    • ConstantTimeToLiveExpirationPolicy

      public ConstantTimeToLiveExpirationPolicy()
      Default constructor. Constructs a policy using a negative time-to-live value that results in entries never expiring.
    • ConstantTimeToLiveExpirationPolicy

      public ConstantTimeToLiveExpirationPolicy(long timeToLiveMillis)
      Construct a policy with the given time-to-live constant measured in milliseconds. A negative time-to-live value indicates entries never expire. A zero time-to-live value indicates entries expire (nearly) immediately.
      Parameters:
      timeToLiveMillis - the constant amount of time (in milliseconds) an entry is available before it expires. A negative value results in entries that NEVER expire. A zero value results in entries that ALWAYS expire.
    • ConstantTimeToLiveExpirationPolicy

      public ConstantTimeToLiveExpirationPolicy(long timeToLive, TimeUnit timeUnit)
      Construct a policy with the given time-to-live constant measured in the given time unit of measure.
      Parameters:
      timeToLive - the constant amount of time an entry is available before it expires. A negative value results in entries that NEVER expire. A zero value results in entries that ALWAYS expire.
      timeUnit - the unit of time for the timeToLive parameter, must not be null.
      Throws:
      NullPointerException - if the time unit is null.
  • Method Details