Module id.xfunction

Package id.xfunction.util

Class TemporaryHashMap<K,V>

Object

TemporaryHashMap<K,V>

All Implemented Interfaces:

Map<K,V>

public class TemporaryHashMap<K,V>
extends Object
implements Map<K,V>

HashMap which caches every pair for specified period of time and when it expires such pair is removed.

The deletion of expired pairs is passive which means they may not be deleted immediately once they are expired but only during next put(Object, Object) or putAll(Map) operations. To change it to active users can setup ScheduledExecutorService to call cleanupExpired().

Keys are subject to expiration and not values associated with them. It means if user adds pair "key1": "val1", and later replace value to "key1": "val2" this will not affect this pair expiration time.

It is based on HashMap so all HashMap properties applies to TemporaryHashMap.

Nested Class Summary

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor	Description
TemporaryHashMap(Duration period)

Method Summary

Modifier and Type	Method	Description
void	cleanupExpired()	Removes expired pairs
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
protected long	currentTimeMillis()	Visible for testing
Set<Map.Entry<K,V>>	entrySet()	Returns Collections.unmodifiableSet(Set)
V	get(Object key)
boolean	isEmpty()
Set<K>	keySet()	Returns Collections.unmodifiableSet(Set)
V	put(K key, V value)
void	putAll(Map<? extends K,? extends V> m)
V	remove(Object key)
int	size()
String	toString()
Collection<V>	values()	Returns Collections.unmodifiableCollection(Collection)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Details

TemporaryHashMap

public TemporaryHashMap(Duration period)

Method Details

size

public int size()

Specified by:

size in interface Map<K,V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

clear

public void clear()

Specified by:

clear in interface Map<K,V>

toString

public String toString()

Overrides:

toString in class Object

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>

get

public V get(Object key)

Specified by:

get in interface Map<K,V>

put

public V put(K key,
 V value)

Specified by:

put in interface Map<K,V>

putAll

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

Specified by:

putAll in interface Map<K,V>

keySet

public Set<K> keySet()

Returns Collections.unmodifiableSet(Set)

Specified by:

keySet in interface Map<K,V>

values

public Collection<V> values()

Returns Collections.unmodifiableCollection(Collection)

Specified by:

values in interface Map<K,V>

entrySet

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

Returns Collections.unmodifiableSet(Set)

Specified by:

entrySet in interface Map<K,V>

remove

public V remove(Object key)

Specified by:

remove in interface Map<K,V>

cleanupExpired

public void cleanupExpired()

Removes expired pairs

currentTimeMillis

protected long currentTimeMillis()

Visible for testing