com.github.dbadia.sqrl.server.util

Class SelfExpiringHashMap<K,V>

java.lang.Object

com.github.dbadia.sqrl.server.util.SelfExpiringHashMap<K,V>

Type Parameters:

K - the Key type

V - the Value type

All Implemented Interfaces:

SelfExpiringMap<K,V>, Map<K,V>

public class SelfExpiringHashMap<K,V>
extends Object
implements SelfExpiringMap<K,V>

As described in http://stackoverflow.com/a/30681018/2863942 https://gist.github.com/pcan/16faf4e59942678377e0#file-selfexpiringhashmap-java A thread-safe implementation of a HashMap which entries expires after the specified life time. The life-time can be defined on a per-key basis, or using a default one, that is passed to the constructor.

Author:

Pierantonio Cangianiello

Nested Class Summary

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
SelfExpiringHashMap() Deprecated. use a constructor that specifies a timeout or don't use this class
SelfExpiringHashMap(long defaultMaxLifeTimeMillis)
SelfExpiringHashMap(long defaultMaxLifeTimeMillis, int initialCapacity)
SelfExpiringHashMap(long defaultMaxLifeTimeMillis, int initialCapacity, float loadFactor)

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<K,V>>	entrySet() Not supported.
V	get(Object key)
boolean	isEmpty()
Set<K>	keySet() Originally threw UnsupportedOperationException.
V	put(K key, V value)
V	put(K key, V value, long lifeTimeMillis) Associates the given key to the given value in this map, with the specified life times in milliseconds.
void	putAll(Map<? extends K,? extends V> m) Not supported.
V	remove(Object key)
boolean	renewKey(K key) Renews the specified key, setting the life time to the initial value.
int	size()
String	toString()
Collection<V>	values() Originally threw UnsupportedOperationException.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

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

Constructor Detail

SelfExpiringHashMap

@Deprecated
public SelfExpiringHashMap()

Deprecated. use a constructor that specifies a timeout or don't use this class

SelfExpiringHashMap

public SelfExpiringHashMap(long defaultMaxLifeTimeMillis)

SelfExpiringHashMap

public SelfExpiringHashMap(long defaultMaxLifeTimeMillis,
                           int initialCapacity)

SelfExpiringHashMap

public SelfExpiringHashMap(long defaultMaxLifeTimeMillis,
                           int initialCapacity,
                           float loadFactor)

Method Detail

size

public int size()

Specified by:

size in interface Map<K,V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty 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>

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>

put

public V put(K key,
             V value,
             long lifeTimeMillis)

Associates the given key to the given value in this map, with the specified life times in milliseconds.

Specified by:

put in interface SelfExpiringMap<K,V>

Returns:

a previously associated object for the given key (if exists).

remove

public V remove(Object key)

Specified by:

remove in interface Map<K,V>

putAll

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

Not supported.

Specified by:

putAll in interface Map<K,V>

renewKey

public boolean renewKey(K key)

Renews the specified key, setting the life time to the initial value.

Specified by:

renewKey in interface SelfExpiringMap<K,V>

Returns:

true if the key is found, false otherwise

clear

public void clear()

Specified by:

clear in interface Map<K,V>

keySet

public Set<K> keySet()

Originally threw UnsupportedOperationException. Modified by Dave

Specified by:

keySet in interface Map<K,V>

values

public Collection<V> values()

Originally threw UnsupportedOperationException. Modified by Dave

Specified by:

values in interface Map<K,V>

entrySet

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

Not supported.

Specified by:

entrySet in interface Map<K,V>

toString

public String toString()

Overrides:

toString in class Object