ExpiringMap (ExpiringMap 0.3.1 API)

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

Type Parameters:
K - Key type
V - Value type

All Implemented Interfaces:

Map<K,V>
```
public class ExpiringMap<K,V>
extends Object
implements Map<K,V>
```
A thread-safe map that expires entries. Optional features include expiration policies, variable entry settings, and expiration listeners.
Entries are tracked by expiration time and expired by a single static Timer.
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. When variable expiration is enabled, put/remove operations impose a log(n) cost.
Example usages:
```
 
 Map map = ExpiringMap.create(); 
 Map map = ExpiringMap.builder().expiration(30, TimeUnit.SECONDS).build(); 
 Map map = ExpiringMap.builder()
      .expiration(10, TimeUnit.MINUTES)
      .expirationListener(new ExpirationListener() { 
          public void expired(String key, Connection connection) { 
              connection.close(); 
          })
      .build(); 
 
```
Author:

Jonathan Halterman

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ExpiringMap.Builder` Builds ExpiringMap instances.
`static interface`	`ExpiringMap.ExpirationListener<K,V>` A listener for expired object events.
`static class`	`ExpiringMap.ExpirationPolicy` Map entry expiration policy.

Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addExpirationListener(ExpiringMap.ExpirationListener<K,V> listener)` Adds an expiration listener.
`static ExpiringMap.Builder`	`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 expiration duration of 60 TimeUnit.SECONDS.
`Set<Map.Entry<K,V>>`	`entrySet()` Not currently supported.
`boolean`	`equals(Object obj)`
`V`	`get(Object 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, ExpiringMap.ExpirationPolicy expirationPolicy)`
`V`	`put(K key, V value, ExpiringMap.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`	`remove(Object key)`
`void`	`removeExpirationListener(ExpiringMap.ExpirationListener<K,V> listener)` Removes an expiration listener.
`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(ExpiringMap.ExpirationPolicy expirationPolicy)` Sets the global expiration policy for the map.
`void`	`setExpirationPolicy(K key, ExpiringMap.ExpirationPolicy expirationPolicy)` Sets the expiration policy for the entry corresponding to the given key.
`int`	`size()`
`Collection<V>`	`values()` Not currently supported.
`Iterator<V>`	`valuesIterator()` Returns an iterator over the map values.

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

- Method Detail
  - builder
```
public static ExpiringMap.Builder 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 expiration duration of 60 TimeUnit.SECONDS.
  - addExpirationListener
```
public void addExpirationListener(ExpiringMap.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()
```
    Not currently supported. Use thiskeySet() and this#entrySetIterable() instead.
    
    Specified by:
    
    entrySet in interface Map<K,V>
    
    Throws:
    
    UnsupportedOperationException
  - 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:
    
    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
    
    Throws:
    
    NullPointerException - on null key
  - put
```
public V put(K key,
    V value,
    ExpiringMap.ExpirationPolicy expirationPolicy)
```
    See Also:
    #put(Object, Object, ExpirationPolicy, long, TimeUnit)}
  - put
```
public V put(K key,
    V value,
    ExpiringMap.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 - unit the unit that duration is expressed in
    
    Throws:
    
    UnsupportedOperationException - If variable expiration is not enabled
    
    NullPointerException - on null key or timeUnit
  - put
```
public V put(K key,
    V value,
    long duration,
    TimeUnit timeUnit)
```
    See Also:
    #put(Object, Object, ExpirationPolicy, long, TimeUnit)}
  - putAll
```
public void putAll(Map<? extends K,? extends V> map)
```
    Specified by:
    
    putAll in interface Map<K,V>
    
    See Also:
    #put(Object, Object)}.
  - remove
```
public V remove(Object key)
```
    Specified by:
    
    remove in interface Map<K,V>
  - removeExpirationListener
```
public void removeExpirationListener(ExpiringMap.ExpirationListener<K,V> listener)
```
    Removes an expiration listener.
    
    Parameters:
    listener -
  - resetExpiration
```
public void resetExpiration(K key)
```
    Resets expiration for the entry corresponding to key.
    
    Parameters:
    key - to reset expiration for
  - 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 - unit the unit that duration is expressed in
    
    Throws:
    
    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 - unit the unit that duration is expressed in
  - setExpirationPolicy
```
public void setExpirationPolicy(ExpiringMap.ExpirationPolicy expirationPolicy)
```
    Sets the global expiration policy for the map.
    
    Parameters:
    expirationPolicy -
  - setExpirationPolicy
```
public void setExpirationPolicy(K key,
                       ExpiringMap.ExpirationPolicy expirationPolicy)
```
    Sets the expiration policy for the entry corresponding to the given key.
    
    Parameters:
    key - to set policy for
    expirationPolicy - to set
    
    Throws:
    
    UnsupportedOperationException - If variable expiration is not enabled
  - size
```
public int size()
```
    Specified by:
    
    size in interface Map<K,V>
  - values
```
public Collection<V> values()
```
    Not currently supported. Use thisvaluesIterator() instead.
    
    Specified by:
    
    values in interface Map<K,V>
    
    Throws:
    
    UnsupportedOperationException
  - valuesIterator
```
public Iterator<V> valuesIterator()
```
    Returns an iterator over the map values.
    
    Throws:
    
    ConcurrentModificationException - if the map's size changes while iterating, excluding calls to (Iteratorremove(Object).

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

Method Detail

builder

create

addExpirationListener

clear

containsKey

containsValue

entrySet

equals

get

getExpiration

getExpiration

hashCode

isEmpty

keySet

put

put

put

put

putAll

remove

removeExpirationListener

resetExpiration

setExpiration

setExpiration

setExpirationPolicy

setExpirationPolicy

size

values

valuesIterator