com.helger.commons.collection.map

Class LRUMap<KEYTYPE,VALUETYPE>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<KEYTYPE,VALUETYPE>

com.helger.commons.collection.impl.CommonsLinkedHashMap<KEYTYPE,VALUETYPE>

com.helger.commons.collection.map.LRUMap<KEYTYPE,VALUETYPE>

Type Parameters:

KEYTYPE - Key type

VALUETYPE - Value type

All Implemented Interfaces:

ICommonsMap<KEYTYPE,VALUETYPE>, ICommonsOrderedMap<KEYTYPE,VALUETYPE>, ICloneable<ICommonsMap<KEYTYPE,VALUETYPE>>, Serializable, Cloneable, Map<KEYTYPE,VALUETYPE>

Direct Known Subclasses:

LoggingLRUMap

@NotThreadSafe
 @UseDirectEqualsAndHashCode
public class LRUMap<KEYTYPE,VALUETYPE>
extends CommonsLinkedHashMap<KEYTYPE,VALUETYPE>

A special ordered map, that has an upper limit of contained elements. It is therefore a "Last Recently Used" map.

Author:

Philip Helger

See Also:

Serialized Form

Nested Class Summary

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

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

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
LRUMap(int nMaxSize) Create a new object with the specified max size.
LRUMap(LRUMap<KEYTYPE,VALUETYPE> rhs)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
LRUMap<KEYTYPE,VALUETYPE>	getClone()
int	getMaxSize()
int	hashCode()
protected void	onRemoveEldestEntry(int nSize, Map.Entry<KEYTYPE,VALUETYPE> aEldest) Protected method that is invoked every time the oldest entry is removed.
protected boolean	removeEldestEntry(Map.Entry<KEYTYPE,VALUETYPE> aEldest)
String	toString()

Methods inherited from class com.helger.commons.collection.impl.CommonsLinkedHashMap

createInstance

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, replaceAll, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.collection.impl.ICommonsOrderedMap

copyOfEntrySet, copyOfKeySet, copyOfKeySet, getLastKey, getLastKey, getLastValue, getLastValue

Methods inherited from interface com.helger.commons.collection.impl.ICommonsMap

addAll, containsAnyEntry, containsAnyKey, containsAnyValue, copyOfValues, copyOfValues, copyOfValuesMapped, copyOfValuesMapped, findFirstEntry, findFirstKey, findFirstValue, forEach, forEachKey, forEachKey, forEachValue, forEachValue, getAsUnmodifiable, getFirstEntry, getFirstEntry, getFirstKey, getFirstKey, getFirstValue, getFirstValue, getSortedByKey, getSortedByValue, getSwappedKeyValues, isNotEmpty, put, putAll, putAll, putAllMapped, putAllMapped, putAllMapped, putIf, putIfNotNull, removeAll, removeIf, removeIfKey, removeIfValue, removeObject, setAll

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Constructor Detail

LRUMap

public LRUMap(@Nonnegative
              int nMaxSize)

Create a new object with the specified max size.

Parameters:

nMaxSize - The maximum number of elements in this cache. May not be < 0.

LRUMap

public LRUMap(@Nonnull
              LRUMap<KEYTYPE,VALUETYPE> rhs)

Method Detail

getClone

@Nonnull
public LRUMap<KEYTYPE,VALUETYPE> getClone()

Specified by:

getClone in interface ICommonsOrderedMap<KEYTYPE,VALUETYPE>

Specified by:

getClone in interface ICloneable<ICommonsMap<KEYTYPE,VALUETYPE>>

Overrides:

getClone in class CommonsLinkedHashMap<KEYTYPE,VALUETYPE>

Returns:

A 100% deep-copy of the implementing class.

getMaxSize

@Nonnegative
public final int getMaxSize()

Returns:

The maximum number of elements that can reside inside this object. Never < 0.

onRemoveEldestEntry

@OverrideOnDemand
protected void onRemoveEldestEntry(@Nonnegative
                                                      int nSize,
                                                      @Nonnull
                                                      Map.Entry<KEYTYPE,VALUETYPE> aEldest)

Protected method that is invoked every time the oldest entry is removed.

Parameters:

nSize - Current size of the map. Always ≥ 0.

aEldest - The map entry that is removed. Never null.

removeEldestEntry

protected final boolean removeEldestEntry(@Nonnull
                                          Map.Entry<KEYTYPE,VALUETYPE> aEldest)

Overrides:

removeEldestEntry in class LinkedHashMap<KEYTYPE,VALUETYPE>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<KEYTYPE,VALUETYPE>

Overrides:

equals in class AbstractMap<KEYTYPE,VALUETYPE>

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<KEYTYPE,VALUETYPE>

Overrides:

hashCode in class AbstractMap<KEYTYPE,VALUETYPE>

toString

public String toString()

Overrides:

toString in class AbstractMap<KEYTYPE,VALUETYPE>