Package de.bsommerfeld.pathetic.engine.util

Class ExpiringHashMap<K,V>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.concurrent.ConcurrentHashMap<K,ExpiringHashMap.Entry<V>>

de.bsommerfeld.pathetic.engine.util.ExpiringHashMap<K,V>

Type Parameters:

K - the type of keys maintained by this map

V - the type of mapped values

All Implemented Interfaces:

Serializable, ConcurrentMap<K,ExpiringHashMap.Entry<V>>, Map<K,ExpiringHashMap.Entry<V>>

public class ExpiringHashMap<K,V>
extends ConcurrentHashMap<K,ExpiringHashMap.Entry<V>>

A ConcurrentHashMap that removes entries on access if they are expired.

The default expiration time is 5 minutes. The cleanup itself is only being triggered every 5 minutes on access by default, but both values can be configured.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExpiringHashMap.Entry<V>	A wrapper for values stored in the ExpiringHashMap that includes an expiration time.

Nested classes/interfaces inherited from class java.util.concurrent.ConcurrentHashMap

ConcurrentHashMap.KeySetView<K extends Object,V extends Object>

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Constructor Summary

Constructors

Constructor	Description
ExpiringHashMap()	Creates a new ExpiringHashMap with default expiration time (5 minutes) and cleanup interval (5 minutes).
ExpiringHashMap(long expirationTime, long cleanupInterval, TimeUnit timeUnit)	Creates a new ExpiringHashMap with the specified expiration time and cleanup interval.
ExpiringHashMap(long expirationTime, TimeUnit timeUnit)	Creates a new ExpiringHashMap with the specified expiration time and default cleanup interval (5 minutes).

Method Summary

Modifier and Type	Method	Description
ExpiringHashMap.Entry<V>	compute(K key, BiFunction<? super K,? super ExpiringHashMap.Entry<V>,? extends ExpiringHashMap.Entry<V>> remappingFunction)
ExpiringHashMap.Entry<V>	computeIfAbsent(K key, Function<? super K,? extends ExpiringHashMap.Entry<V>> mappingFunction)
ExpiringHashMap.Entry<V>	computeIfPresent(K key, BiFunction<? super K,? super ExpiringHashMap.Entry<V>,? extends ExpiringHashMap.Entry<V>> remappingFunction)
boolean	containsKey(Object key)	Returns true if the map contains a mapping for the specified key and the value has not expired.
boolean	containsRawValue(V value)	Returns true if the map contains a mapping with the specified raw value and the entry has not expired.
boolean	containsValue(Object value)
Set<Map.Entry<K,ExpiringHashMap.Entry<V>>>	entrySetWithCleanup()	Removes expired entries and then returns the entry set.
ExpiringHashMap.Entry<V>	get(Object key)
long	getCleanupIntervalMs()	Returns the cleanup interval in milliseconds.
long	getExpirationTimeMs()	Returns the expiration time for entries in milliseconds.
V	getValue(Object key)	Returns the value associated with the key, or null if the key is not in the map or the value has expired.
Set<K>	keySetWithCleanup()	Removes expired entries and then returns the key set.
ExpiringHashMap.Entry<V>	merge(K key, ExpiringHashMap.Entry<V> value, BiFunction<? super ExpiringHashMap.Entry<V>,? super ExpiringHashMap.Entry<V>,? extends ExpiringHashMap.Entry<V>> remappingFunction)
ExpiringHashMap.Entry<V>	put(K key, ExpiringHashMap.Entry<V> value)
void	putAll(Map<? extends K,? extends ExpiringHashMap.Entry<V>> m)
ExpiringHashMap.Entry<V>	putIfAbsent(K key, ExpiringHashMap.Entry<V> value)
V	putValue(K key, V value)	Puts a value in the map with the default expiration time.
V	putValueIfAbsent(K key, V value)	Puts a value in the map if the key is not already associated with a value or if the current value has expired.
V	putWithExpiration(K key, V value, long expirationTime, TimeUnit timeUnit)	Puts a value in the map with a custom expiration time.
ExpiringHashMap.Entry<V>	remove(Object key)
boolean	remove(Object key, Object value)
V	removeValue(Object key)	Removes the mapping for the specified key and returns the value that was associated with the key.
ExpiringHashMap.Entry<V>	replace(K key, ExpiringHashMap.Entry<V> value)
boolean	replace(K key, ExpiringHashMap.Entry<V> oldValue, ExpiringHashMap.Entry<V> newValue)
void	replaceAll(BiFunction<? super K,? super ExpiringHashMap.Entry<V>,? extends ExpiringHashMap.Entry<V>> function)
Collection<ExpiringHashMap.Entry<V>>	valuesWithCleanup()	Removes expired entries and then returns the values.

Methods inherited from class java.util.concurrent.ConcurrentHashMap

clear, contains, elements, entrySet, equals, forEach, forEach, forEach, forEachEntry, forEachEntry, forEachKey, forEachKey, forEachValue, forEachValue, getOrDefault, hashCode, isEmpty, keys, keySet, keySet, mappingCount, newKeySet, newKeySet, reduce, reduceEntries, reduceEntries, reduceEntriesToDouble, reduceEntriesToInt, reduceEntriesToLong, reduceKeys, reduceKeys, reduceKeysToDouble, reduceKeysToInt, reduceKeysToLong, reduceToDouble, reduceToInt, reduceToLong, reduceValues, reduceValues, reduceValuesToDouble, reduceValuesToInt, reduceValuesToLong, search, searchEntries, searchKeys, searchValues, size, toString, values

Methods inherited from class java.util.AbstractMap

clone

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ExpiringHashMap

public ExpiringHashMap()

Creates a new ExpiringHashMap with default expiration time (5 minutes) and cleanup interval (5 minutes).

ExpiringHashMap

public ExpiringHashMap(long expirationTime,
 TimeUnit timeUnit)

Creates a new ExpiringHashMap with the specified expiration time and default cleanup interval (5 minutes).

Parameters:

expirationTime - the expiration time for entries

timeUnit - the time unit of the expiration time

ExpiringHashMap

public ExpiringHashMap(long expirationTime,
 long cleanupInterval,
 TimeUnit timeUnit)

Creates a new ExpiringHashMap with the specified expiration time and cleanup interval.

Parameters:

expirationTime - the expiration time for entries

cleanupInterval - the interval between cleanup operations

timeUnit - the time unit of both the expiration time and cleanup interval

Method Details

getExpirationTimeMs

public long getExpirationTimeMs()

Returns the expiration time for entries in milliseconds.

Returns:

the expiration time in milliseconds

getCleanupIntervalMs

public long getCleanupIntervalMs()

Returns the cleanup interval in milliseconds.

Returns:

the cleanup interval in milliseconds

putValue

public V putValue(K key,
 V value)

Puts a value in the map with the default expiration time.

Parameters:

key - the key

value - the value

Returns:

the previous value associated with the key, or null if there was no mapping

putWithExpiration

public V putWithExpiration(K key,
 V value,
 long expirationTime,
 TimeUnit timeUnit)

Puts a value in the map with a custom expiration time.

Parameters:

key - the key

value - the value

expirationTime - the expiration time

timeUnit - the time unit of the expiration time

Returns:

the previous value associated with the key, or null if there was no mapping

getValue

public V getValue(Object key)

Returns the value associated with the key, or null if the key is not in the map or the value has expired.

Parameters:

key - the key

Returns:

the value associated with the key, or null if the key is not in the map or the value has expired

putValueIfAbsent

public V putValueIfAbsent(K key,
 V value)

Puts a value in the map if the key is not already associated with a value or if the current value has expired.

Parameters:

key - the key

value - the value

Returns:

the previous value associated with the key, or null if there was no mapping or the value had expired

removeValue

public V removeValue(Object key)

Removes the mapping for the specified key and returns the value that was associated with the key.

Parameters:

key - the key

Returns:

the value associated with the key, or null if the key was not in the map

containsKey

public boolean containsKey(Object key)

Returns true if the map contains a mapping for the specified key and the value has not expired.

Specified by:

containsKey in interface Map<K,V>

Overrides:

containsKey in class ConcurrentHashMap<K,ExpiringHashMap.Entry<V>>

Parameters:

key - the key

Returns:

true if the map contains a mapping for the specified key and the value has not expired

containsRawValue

public boolean containsRawValue(V value)

Returns true if the map contains a mapping with the specified raw value and the entry has not expired.

Parameters:

value - the raw value (not wrapped in an Entry)

Returns:

true if the map contains a mapping with the specified value and the entry has not expired

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K,V>

Overrides:

containsValue in class ConcurrentHashMap<K,ExpiringHashMap.Entry<V>>

put

public ExpiringHashMap.Entry<V> put(K key,
 ExpiringHashMap.Entry<V> value)

Specified by:

put in interface Map<K,V>

Overrides:

put in class ConcurrentHashMap<K,ExpiringHashMap.Entry<V>>

putAll

public void putAll(Map<? extends K,? extends ExpiringHashMap.Entry<V>> m)

Specified by:

putAll in interface Map<K,V>

Overrides:

putAll in class ConcurrentHashMap<K,ExpiringHashMap.Entry<V>>

putIfAbsent

public ExpiringHashMap.Entry<V> putIfAbsent(K key,
 ExpiringHashMap.Entry<V> value)

Specified by:

putIfAbsent in interface ConcurrentMap<K,V>

Specified by:

putIfAbsent in interface Map<K,V>

Overrides:

putIfAbsent in class ConcurrentHashMap<K,ExpiringHashMap.Entry<V>>

get

public ExpiringHashMap.Entry<V> get(Object key)

Specified by:

get in interface Map<K,V>

Overrides:

get in class ConcurrentHashMap<K,ExpiringHashMap.Entry<V>>

remove

public ExpiringHashMap.Entry<V> remove(Object key)

Specified by:

remove in interface Map<K,V>

Overrides:

remove in class ConcurrentHashMap<K,ExpiringHashMap.Entry<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>

Overrides:

remove in class ConcurrentHashMap<K,ExpiringHashMap.Entry<V>>

replace

public ExpiringHashMap.Entry<V> replace(K key,
 ExpiringHashMap.Entry<V> value)

Specified by:

replace in interface ConcurrentMap<K,V>

Specified by:

replace in interface Map<K,V>

Overrides:

replace in class ConcurrentHashMap<K,ExpiringHashMap.Entry<V>>

replace

public boolean replace(K key,
 ExpiringHashMap.Entry<V> oldValue,
 ExpiringHashMap.Entry<V> newValue)

Specified by:

replace in interface ConcurrentMap<K,V>

Specified by:

replace in interface Map<K,V>

Overrides:

replace in class ConcurrentHashMap<K,ExpiringHashMap.Entry<V>>

replaceAll

public void replaceAll(BiFunction<? super K,? super ExpiringHashMap.Entry<V>,? extends ExpiringHashMap.Entry<V>> function)

Specified by:

replaceAll in interface ConcurrentMap<K,V>

Specified by:

replaceAll in interface Map<K,V>

Overrides:

replaceAll in class ConcurrentHashMap<K,ExpiringHashMap.Entry<V>>

computeIfAbsent

public ExpiringHashMap.Entry<V> computeIfAbsent(K key,
 Function<? super K,? extends ExpiringHashMap.Entry<V>> mappingFunction)

Specified by:

computeIfAbsent in interface ConcurrentMap<K,V>

Specified by:

computeIfAbsent in interface Map<K,V>

Overrides:

computeIfAbsent in class ConcurrentHashMap<K,ExpiringHashMap.Entry<V>>

computeIfPresent

public ExpiringHashMap.Entry<V> computeIfPresent(K key,
 BiFunction<? super K,? super ExpiringHashMap.Entry<V>,? extends ExpiringHashMap.Entry<V>> remappingFunction)

Specified by:

computeIfPresent in interface ConcurrentMap<K,V>

Specified by:

computeIfPresent in interface Map<K,V>

Overrides:

computeIfPresent in class ConcurrentHashMap<K,ExpiringHashMap.Entry<V>>

compute

public ExpiringHashMap.Entry<V> compute(K key,
 BiFunction<? super K,? super ExpiringHashMap.Entry<V>,? extends ExpiringHashMap.Entry<V>> remappingFunction)

Specified by:

compute in interface ConcurrentMap<K,V>

Specified by:

compute in interface Map<K,V>

Overrides:

compute in class ConcurrentHashMap<K,ExpiringHashMap.Entry<V>>

merge

public ExpiringHashMap.Entry<V> merge(K key,
 ExpiringHashMap.Entry<V> value,
 BiFunction<? super ExpiringHashMap.Entry<V>,? super ExpiringHashMap.Entry<V>,? extends ExpiringHashMap.Entry<V>> remappingFunction)

Specified by:

merge in interface ConcurrentMap<K,V>

Specified by:

merge in interface Map<K,V>

Overrides:

merge in class ConcurrentHashMap<K,ExpiringHashMap.Entry<V>>

keySetWithCleanup

public Set<K> keySetWithCleanup()

Removes expired entries and then returns the key set.

Returns:

the key set

valuesWithCleanup

public Collection<ExpiringHashMap.Entry<V>> valuesWithCleanup()

Removes expired entries and then returns the values.

Returns:

the values

entrySetWithCleanup

public Set<Map.Entry<K,ExpiringHashMap.Entry<V>>> entrySetWithCleanup()

Removes expired entries and then returns the entry set.

Returns:

the entry set