Package com.helger.commons.collection.map

Class LoggingLRUMap<KEYTYPE,VALUETYPE>

java.lang.Object

java.util.AbstractMap<KEYTYPE,VALUETYPE>

java.util.HashMap<KEYTYPE,VALUETYPE>

java.util.LinkedHashMap<KEYTYPE,VALUETYPE>

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

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

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

Type Parameters:

KEYTYPE - Map key type

VALUETYPE - Map value type

All Implemented Interfaces:

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

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

A specific LRUMap that emits a warning once the map is full and the oldest entry gets discarded.

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	Description
LoggingLRUMap(int nMaxSize)
LoggingLRUMap(LoggingLRUMap<KEYTYPE,VALUETYPE> rhs)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
LoggingLRUMap<KEYTYPE,VALUETYPE>	getClone()
String	getMapName()
int	hashCode()
protected void	onRemoveEldestEntry(int nSize, Map.Entry<KEYTYPE,VALUETYPE> aEntry)	Protected method that is invoked every time the oldest entry is removed.
final LoggingLRUMap<KEYTYPE,VALUETYPE>	setMapName(String sMapName)
String	toString()

Methods inherited from class com.helger.commons.collection.map.LRUMap

getMaxSize, removeEldestEntry

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, newLinkedHashMap, putFirst, putLast, replaceAll, reversed, sequencedEntrySet, sequencedKeySet, sequencedValues, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, newHashMap, 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.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 com.helger.commons.collection.impl.ICommonsOrderedMap

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

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

Methods inherited from interface java.util.SequencedMap

firstEntry, lastEntry, pollFirstEntry, pollLastEntry

Constructor Details

LoggingLRUMap

public LoggingLRUMap(@Nonnegative
 int nMaxSize)

LoggingLRUMap

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

Method Details

getClone

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

Specified by:

getClone in interface ICloneable<KEYTYPE>

Specified by:

getClone in interface ICommonsOrderedMap<KEYTYPE,VALUETYPE>

Overrides:

getClone in class LRUMap<KEYTYPE,VALUETYPE>

Returns:

A 100% deep-copy of the implementing class.

getMapName

@Nullable
public String getMapName()

setMapName

@Nonnull
public final LoggingLRUMap<KEYTYPE,VALUETYPE> setMapName(@Nullable
 String sMapName)

onRemoveEldestEntry

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

Description copied from class: LRUMap

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

Overrides:

onRemoveEldestEntry in class LRUMap<KEYTYPE,VALUETYPE>

Parameters:

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

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

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<KEYTYPE,VALUETYPE>

Overrides:

equals in class LRUMap<KEYTYPE,VALUETYPE>

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<KEYTYPE,VALUETYPE>

Overrides:

hashCode in class LRUMap<KEYTYPE,VALUETYPE>

toString

public String toString()

Overrides:

toString in class LRUMap<KEYTYPE,VALUETYPE>