Package de.mhus.lib.core.util

Class SoftTimeoutMap<K,V>

java.lang.Object

de.mhus.lib.core.util.SoftTimeoutMap<K,V>

All Implemented Interfaces:

Map<K,V>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SoftTimeoutMap.Invalidator<K,V>

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

Map.Entry<K extends Object,V extends Object>

Constructor Summary

Constructors

Constructor	Description
SoftTimeoutMap()
SoftTimeoutMap(long timeout)
SoftTimeoutMap(long timeout, boolean refreshOnAccess)
SoftTimeoutMap(long timeout, long checkTimeout, boolean refreshOnAccess)
SoftTimeoutMap(long timeout, long checkTimeout, boolean refreshOnAccess, SoftTimeoutMap.Invalidator<K,V> invalidator)

Method Summary

Modifier and Type	Method	Description
void	clear()
V	compute(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)
V	computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction)
V	computeIfPresent(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)
boolean	containsKey(Object key)
boolean	containsValue(Object value)
void	doValidationCheck()
Set<Map.Entry<K,V>>	entrySet()
boolean	equals(Object o)
void	forEach(BiConsumer<? super K,? super V> action)
V	get(Object key)
long	getAccessCount(Object key)
long	getCheckTimeout()
SoftTimeoutMap.Invalidator<K,V>	getInvalidator()
V	getOrDefault(Object key, V defaultValue)
long	getTimeout()
int	hashCode()
boolean	isEmpty()
boolean	isRefreshOnAccess()
Set<K>	keySet()
V	merge(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction)
V	put(K key, V value)
void	putAll(Map<? extends K,? extends V> m)
V	putIfAbsent(K key, V value)
V	remove(Object key)
boolean	remove(Object key, Object value)
V	replace(K key, V value)
boolean	replace(K key, V oldValue, V newValue)
void	replaceAll(BiFunction<? super K,? super V,? extends V> function)
void	setCheckTimeout(long checkTimeout)	Set the time after a full check should be done.
void	setInvalidator(SoftTimeoutMap.Invalidator<K,V> invalidator)	Set a function which can decide if the entry is no more valid.
void	setRefreshOnAccess(boolean refreshOnAccess)	Set to true if also get requests will reset the timeout.
void	setTimeout(long timeout)	Set the maximal life time for every entry.
int	size()
Collection<V>	values()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SoftTimeoutMap

public SoftTimeoutMap()

SoftTimeoutMap

public SoftTimeoutMap(long timeout)

SoftTimeoutMap

public SoftTimeoutMap(long timeout,
                      boolean refreshOnAccess)

SoftTimeoutMap

public SoftTimeoutMap(long timeout,
                      long checkTimeout,
                      boolean refreshOnAccess)

SoftTimeoutMap

public SoftTimeoutMap(long timeout,
                      long checkTimeout,
                      boolean refreshOnAccess,
                      SoftTimeoutMap.Invalidator<K,V> invalidator)

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>

getAccessCount

public long getAccessCount(Object key)

doValidationCheck

public void doValidationCheck()

put

public V put(K key,
             V value)

Specified by:

put in interface Map<K,V>

remove

public V remove(Object key)

Specified by:

remove in interface Map<K,V>

putAll

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

Specified by:

putAll in interface Map<K,V>

clear

public void clear()

Specified by:

clear in interface Map<K,V>

keySet

public Set<K> keySet()

Specified by:

keySet in interface Map<K,V>

values

public Collection<V> values()

Specified by:

values 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 o)

Specified by:

equals in interface Map<K,V>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<K,V>

Overrides:

hashCode in class Object

getOrDefault

public V getOrDefault(Object key,
                      V defaultValue)

Specified by:

getOrDefault in interface Map<K,V>

forEach

public void forEach(BiConsumer<? super K,? super V> action)

Specified by:

forEach in interface Map<K,V>

replaceAll

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

Specified by:

replaceAll in interface Map<K,V>

putIfAbsent

public V putIfAbsent(K key,
                     V value)

Specified by:

putIfAbsent in interface Map<K,V>

remove

public boolean remove(Object key,
                      Object value)

Specified by:

remove in interface Map<K,V>

replace

public boolean replace(K key,
                       V oldValue,
                       V newValue)

Specified by:

replace in interface Map<K,V>

replace

public V replace(K key,
                 V value)

Specified by:

replace in interface Map<K,V>

computeIfAbsent

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

Specified by:

computeIfAbsent in interface Map<K,V>

computeIfPresent

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

Specified by:

computeIfPresent in interface Map<K,V>

compute

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

Specified by:

compute in interface Map<K,V>

merge

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

Specified by:

merge in interface Map<K,V>

getTimeout

public long getTimeout()

setTimeout

public void setTimeout(long timeout)

Set the maximal life time for every entry. After the timeout the entry will be removed.

Parameters:

timeout - timeout in ms

getCheckTimeout

public long getCheckTimeout()

setCheckTimeout

public void setCheckTimeout(long checkTimeout)

Set the time after a full check should be done. If the map is accesses after timeout a full check over all elements will be performed. Set to -1 to disable.

Parameters:

checkTimeout - timeout in ms

getInvalidator

public SoftTimeoutMap.Invalidator<K,V> getInvalidator()

setInvalidator

public void setInvalidator(SoftTimeoutMap.Invalidator<K,V> invalidator)

Set a function which can decide if the entry is no more valid.

Parameters:

invalidator -

isRefreshOnAccess

public boolean isRefreshOnAccess()

setRefreshOnAccess

public void setRefreshOnAccess(boolean refreshOnAccess)

Set to true if also get requests will reset the timeout. If set to false it will timeout even it was read. Default is true.

Parameters:

refreshOnAccess -