ExpiringMap (ExpiringMap 0.5.1 API)

java.lang.Object
- net.jodah.expiringmap.ExpiringMap<K,V>

Type Parameters:

K - Key type

V - Value type

All Implemented Interfaces:

ConcurrentMap<K,V>, Map<K,V>
```
public class ExpiringMap<K,V>
extends Object
implements ConcurrentMap<K,V>
```
A thread-safe map that expires entries. Optional features include expiration policies, variable entry expiration, lazy entry loading, and expiration listeners.
Entries are tracked by expiration time and expired by a single Timer thread.
Expiration listeners will automatically be assigned to run in the context of the Timer thread or in a separate thread based on their first timed duration.
When variable expiration is disabled (default), put/remove operations are constant O(n). When variable expiration is enabled, put/remove operations impose an O(log n) cost.
Example usages:
```
  
 Map<String, Integer> map = ExpiringMap.create(); 
 Map<String, Integer> map = ExpiringMap.builder().expiration(30, TimeUnit.SECONDS).build();
 Map<String, Connection> map = ExpiringMap.builder()
   .expiration(10, TimeUnit.MINUTES)
   .entryLoader(new EntryLoader<String, Connection>() {
     public Connection load(String address) {
       return new Connection(address);
     }
   })
   .expirationListener(new ExpirationListener<String, Connection>() { 
     public void expired(String key, Connection connection) { 
       connection.close();
     } 
   })
   .build();
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ExpiringMap.Builder<K,V>
Builds ExpiringMap instances.
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Nested Classes
Modifier and Type	Class and Description
`static class`	`ExpiringMap.Builder<K,V>` Builds ExpiringMap instances.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addExpirationListener(ExpirationListener<K,V> listener)` Adds an expiration listener.
`static ExpiringMap.Builder<Object,Object>`	`builder()` Creates an ExpiringMap builder.
`void`	`clear()`
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(Object value)`
`static <K,V> ExpiringMap<K,V>`	`create()` Creates a new instance of ExpiringMap with ExpirationPolicy.CREATED and an expiration of 60 seconds.
`Set<Map.Entry<K,V>>`	`entrySet()`
`boolean`	`equals(Object obj)`
`V`	`get(Object key)`
`long`	`getExpectedExpiration(K key)` Gets the expected expiration in milliseconds for the entry corresponding to the given key.
`long`	`getExpiration()` Returns the map's default expiration duration in milliseconds.
`long`	`getExpiration(K key)` Gets the expiration duration in milliseconds for the entry corresponding to the given key.
`int`	`hashCode()`
`boolean`	`isEmpty()`
`Set<K>`	`keySet()`
`V`	`put(K key, V value)` Puts `value` in the map for `key`.
`V`	`put(K key, V value, ExpirationPolicy expirationPolicy)`
`V`	`put(K key, V value, ExpirationPolicy expirationPolicy, long duration, TimeUnit timeUnit)` Puts `value` in the map for `key`.
`V`	`put(K key, V value, long duration, TimeUnit timeUnit)`
`void`	`putAll(Map<? extends K,? extends V> map)`
`V`	`putIfAbsent(K key, V value)`
`V`	`remove(Object key)`
`boolean`	`remove(Object key, Object value)`
`void`	`removeExpirationListener(ExpirationListener<K,V> listener)` Removes an expiration listener.
`V`	`replace(K key, V value)`
`boolean`	`replace(K key, V oldValue, V newValue)`
`void`	`resetExpiration(K key)` Resets expiration for the entry corresponding to `key`.
`void`	`setExpiration(K key, long duration, TimeUnit timeUnit)` Sets the expiration duration for the entry corresponding to the given key.
`void`	`setExpiration(long duration, TimeUnit timeUnit)` Updates the default map entry expiration.
`void`	`setExpirationPolicy(ExpirationPolicy expirationPolicy)` Sets the global expiration policy for the map.
`void`	`setExpirationPolicy(K key, ExpirationPolicy expirationPolicy)` Sets the expiration policy for the entry corresponding to the given key.
`int`	`size()`
`String`	`toString()`
`Collection<V>`	`values()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.concurrent.ConcurrentMap
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, replaceAll

- Method Detail
  - builder
```
public static ExpiringMap.Builder<Object,Object> builder()
```
    Creates an ExpiringMap builder.
    
    Returns:
    
    New ExpiringMap builder
  - create
```
public static <K,V> ExpiringMap<K,V> create()
```
    Creates a new instance of ExpiringMap with ExpirationPolicy.CREATED and an expiration of 60 seconds.
  - addExpirationListener
```
public void addExpirationListener(ExpirationListener<K,V> listener)
```
    Adds an expiration listener.
    
    Parameters:
    
    listener - to add
    
    Throws:
    
    NullPointerException - if listener is null
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Map<K,V>
  - containsKey
```
public boolean containsKey(Object key)
```
    Specified by:
    
    containsKey in interface Map<K,V>
  - containsValue
```
public boolean containsValue(Object value)
```
    Specified by:
    
    containsValue in interface Map<K,V>
  - entrySet
```
public Set<Map.Entry<K,V>> entrySet()
```
    Specified by:
    
    entrySet in interface Map<K,V>
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in interface Map<K,V>
    
    Overrides:
    
    equals in class Object
  - get
```
public V get(Object key)
```
    Specified by:
    
    get in interface Map<K,V>
  - getExpiration
```
public long getExpiration()
```
    Returns the map's default expiration duration in milliseconds.
    
    Returns:
    
    The expiration duration (milliseconds)
  - getExpiration
```
public long getExpiration(K key)
```
    Gets the expiration duration in milliseconds for the entry corresponding to the given key.
    
    Parameters:
    
    key -
    
    Returns:
    
    The expiration duration in milliseconds
    
    Throws:
    
    NullPointerException - if key is null
    
    NoSuchElementException - If no entry exists for the given key
  - getExpectedExpiration
```
public long getExpectedExpiration(K key)
```
    Gets the expected expiration in milliseconds for the entry corresponding to the given key.
    
    Parameters:
    
    key -
    
    Returns:
    
    The expiration duration in milliseconds
    
    Throws:
    
    NullPointerException - if key is null
    
    NoSuchElementException - If no entry exists for the given key
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Map<K,V>
    
    Overrides:
    
    hashCode in class Object
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Map<K,V>
  - keySet
```
public Set<K> keySet()
```
    Specified by:
    
    keySet in interface Map<K,V>
  - put
```
public V put(K key,
             V value)
```
    Puts value in the map for key. Resets the entry's expiration unless an entry already exists for the same key and value.
    
    Specified by:
    
    put in interface Map<K,V>
    
    Parameters:
    
    key - to put value for
    
    value - to put for key
    
    Returns:
    
    the old value
    
    Throws:
    
    NullPointerException - if key is null
  - put
```
public V put(K key,
             V value,
             ExpirationPolicy expirationPolicy)
```
    See Also:
    
    put(Object, Object, ExpirationPolicy, long, TimeUnit)
  - put
```
public V put(K key,
             V value,
             long duration,
             TimeUnit timeUnit)
```
    See Also:
    
    put(Object, Object, ExpirationPolicy, long, TimeUnit)
  - put
```
public V put(K key,
             V value,
             ExpirationPolicy expirationPolicy,
             long duration,
             TimeUnit timeUnit)
```
    Puts value in the map for key. Resets the entry's expiration unless an entry already exists for the same key and value. Requires that variable expiration be enabled.
    
    Parameters:
    
    key - Key to put value for
    
    value - Value to put for key
    
    duration - the length of time after an entry is created that it should be removed
    
    timeUnit - the unit that duration is expressed in
    
    Returns:
    
    the old value
    
    Throws:
    
    UnsupportedOperationException - If variable expiration is not enabled
    
    NullPointerException - if key, expirationPolicy or timeUnit are null
  - putAll
```
public void putAll(Map<? extends K,? extends V> map)
```
    Specified by:
    
    putAll in interface Map<K,V>
  - putIfAbsent
```
public V putIfAbsent(K key,
                     V value)
```
    Specified by:
    
    putIfAbsent in interface ConcurrentMap<K,V>
    
    Specified by:
    
    putIfAbsent in interface Map<K,V>
  - remove
```
public V remove(Object key)
```
    Specified by:
    
    remove in interface Map<K,V>
  - remove
```
public boolean remove(Object key,
                      Object value)
```
    Specified by:
    
    remove in interface ConcurrentMap<K,V>
    
    Specified by:
    
    remove in interface Map<K,V>
  - replace
```
public V replace(K key,
                 V value)
```
    Specified by:
    
    replace in interface ConcurrentMap<K,V>
    
    Specified by:
    
    replace in interface Map<K,V>
  - replace
```
public boolean replace(K key,
                       V oldValue,
                       V newValue)
```
    Specified by:
    
    replace in interface ConcurrentMap<K,V>
    
    Specified by:
    
    replace in interface Map<K,V>
  - removeExpirationListener
```
public void removeExpirationListener(ExpirationListener<K,V> listener)
```
    Removes an expiration listener.
    
    Parameters:
    
    listener -
    
    Throws:
    
    NullPointerException - if listener is null
  - resetExpiration
```
public void resetExpiration(K key)
```
    Resets expiration for the entry corresponding to key.
    
    Parameters:
    
    key - to reset expiration for
    
    Throws:
    
    NullPointerException - if key is null
  - setExpiration
```
public void setExpiration(K key,
                          long duration,
                          TimeUnit timeUnit)
```
    Sets the expiration duration for the entry corresponding to the given key. Supported only if variable expiration is enabled.
    
    Parameters:
    
    key - Key to set expiration for
    
    duration - the length of time after an entry is created that it should be removed
    
    timeUnit - the unit that duration is expressed in
    
    Throws:
    
    NullPointerException - if key or timeUnit are null
    
    UnsupportedOperationException - If variable expiration is not enabled
  - setExpiration
```
public void setExpiration(long duration,
                          TimeUnit timeUnit)
```
    Updates the default map entry expiration. Supported only if variable expiration is enabled.
    
    Parameters:
    
    duration - the length of time after an entry is created that it should be removed
    
    timeUnit - the unit that duration is expressed in
    
    Throws:
    
    NullPointerException - timeUnit is null
    
    UnsupportedOperationException - If variable expiration is not enabled
  - setExpirationPolicy
```
public void setExpirationPolicy(ExpirationPolicy expirationPolicy)
```
    Sets the global expiration policy for the map.
    
    Parameters:
    
    expirationPolicy -
    
    Throws:
    
    NullPointerException - expirationPolicy is null
  - setExpirationPolicy
```
public void setExpirationPolicy(K key,
                                ExpirationPolicy expirationPolicy)
```
    Sets the expiration policy for the entry corresponding to the given key.
    
    Parameters:
    
    key - to set policy for
    
    expirationPolicy - to set
    
    Throws:
    
    NullPointerException - if key or expirationPolicy are null
    
    UnsupportedOperationException - If variable expiration is not enabled
  - size
```
public int size()
```
    Specified by:
    
    size in interface Map<K,V>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - values
```
public Collection<V> values()
```
    Specified by:
    
    values in interface Map<K,V>

Class ExpiringMap<K,V>

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.concurrent.ConcurrentMap

Method Detail

builder

create

addExpirationListener

clear

containsKey

containsValue

entrySet

equals

get

getExpiration

getExpiration

getExpectedExpiration

hashCode

isEmpty

keySet

put

put

put

put

putAll

putIfAbsent

remove

remove

replace

replace

removeExpirationListener

resetExpiration

setExpiration

setExpiration

setExpirationPolicy

setExpirationPolicy

size

toString

values