net.markenwerk.utils.lrucache

Class LruCache<Key,Value>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<Key,Value>

net.markenwerk.utils.lrucache.LruCache<Key,Value>

Type Parameters:

Key - The key type.

Value - The value type.

All Implemented Interfaces:

Serializable, Cloneable, Map<Key,Value>

public final class LruCache<Key,Value>
extends LinkedHashMap<Key,Value>

A LruCache is a LinkedHashMap that is configured to hold it's Entries in access order and evicts the least recently accessed Map.Entry, if the configured cache size is exceeded.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

See Also:

Serialized Form

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor and Description
LruCache(int cacheSize) Creates a new LruCache without a LruCacheListener.
LruCache(int cacheSize, LruCacheListener<Key,Value> listener) Creates a new LruCache.

Method Summary

Modifier and Type	Method and Description
protected boolean	removeEldestEntry(Map.Entry<Key,Value> eldest)

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.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

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

Constructor Detail

LruCache

public LruCache(int cacheSize)
         throws IllegalArgumentException

Creates a new LruCache without a LruCacheListener.

Parameters:

cacheSize - The cache size to be used.

Throws:

IllegalArgumentException - If the given cache size is negative.

LruCache

public LruCache(int cacheSize,
                LruCacheListener<Key,Value> listener)
         throws IllegalArgumentException

Creates a new LruCache.

Parameters:

cacheSize - The cache size to be used.

listener - The LruCacheListener to be used, or null, if no LruCacheListener should be used.

Throws:

IllegalArgumentException - If the given cache size is negative.

Method Detail

removeEldestEntry

protected boolean removeEldestEntry(Map.Entry<Key,Value> eldest)

Overrides:

removeEldestEntry in class LinkedHashMap<Key,Value>