at.molindo.thirdparty.org.compass.core.util.concurrent

Class ConcurrentLinkedHashMap<K,V>

java.lang.Object

java.util.AbstractMap<K,V>

at.molindo.thirdparty.org.compass.core.util.concurrent.ConcurrentLinkedHashMap<K,V>

All Implemented Interfaces:

java.io.Serializable, java.util.concurrent.ConcurrentMap<K,V>, java.util.Map<K,V>

public class ConcurrentLinkedHashMap<K,V>
extends java.util.AbstractMap<K,V>
implements java.util.concurrent.ConcurrentMap<K,V>, java.io.Serializable

A ConcurrentMap with a doubly-linked list running through its entries. This class provides the same semantics as a ConcurrentHashMap in terms of iterators, acceptable keys, and concurrency characteristics, but perform slightly worse due to the added expense of maintaining the linked list. It differs from LinkedHashMap in that it does not provide predictable iteration order. This map is intended to be used for caches and provides the following eviction policies:

• First-in, First-out: Also known as insertion order. This policy has excellent concurrency characteristics and an adequate hit rate.
• Second-chance: An enhanced FIFO policy that marks entries that have been retrieved and saves them from being evicted until the next pass. This enhances the FIFO policy by making it aware of "hot" entries, which increases its hit rate to be equal to an LRU's under normal workloads. In the worst case, where all entries have been saved, this policy degrades to a FIFO.
• Least Recently Used: An eviction policy based on the observation that entries that have been used recently will likely be used again soon. This policy provides a good approximation of an optimal algorithm, but suffers by being expensive to maintain. The cost of reordering entries on the list during every access operation reduces the concurrency and performance characteristics of this policy.

The Second Chance eviction policy is recommended for common use cases as it provides the best mix of performance and efficiency of the supported replacement policies. If the Least Recently Used policy is chosen then the sizing should compensate for the proliferation of dead nodes on the linked list. While the values are removed immediately, the nodes are evicted only when they reach the head of the list. Under FIFO-based policies, dead nodes occur when explicit removals are requested and does not normally produce a noticeable impact on the map's hit rate. The LRU policy creates a dead node on every successful retrieval and a new node is placed at the tail of the list. For this reason, the LRU's efficiency cannot be compared directly to a LinkedHashMap evicting in access order.

Author:

Ben Manes

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ConcurrentLinkedHashMap.EvictionListener<K,V> A listener registered for notification when an entry is evicted.
static class	ConcurrentLinkedHashMap.EvictionPolicy The replacement policy to apply to determine which entry to discard to when the capacity has been reached.

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

java.util.AbstractMap.SimpleImmutableEntry<K,V>

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ConcurrentLinkedHashMap(ConcurrentLinkedHashMap.EvictionPolicy policy, int maximumCapacity, ConcurrentLinkedHashMap.EvictionListener<K,V>... listeners) Creates a new, empty, unbounded map with the specified maximum capacity and the default concurrencyLevel.
ConcurrentLinkedHashMap(ConcurrentLinkedHashMap.EvictionPolicy policy, int maximumCapacity, int concurrencyLevel, ConcurrentLinkedHashMap.EvictionListener<K,V>... listeners) Creates a new, empty, unbounded map with the specified maximum capacity and concurrency level.

Method Summary

Methods

Modifier and Type	Method and Description
int	capacity() Retrieves the maximum capacity of the map.
void	clear()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.util.Set<java.util.Map.Entry<K,V>>	entrySet()
V	get(java.lang.Object key)
V	put(K key, V value)
V	putIfAbsent(K key, V value)
V	remove(java.lang.Object key)
boolean	remove(java.lang.Object key, java.lang.Object value)
V	replace(K key, V value)
boolean	replace(K key, V oldValue, V newValue)
void	setCapacity(int capacity) Sets the maximum capacity of the map and eagerly evicts entries until the it shrinks to the appropriate size.
int	size()

Methods inherited from class java.util.AbstractMap

clone, equals, hashCode, isEmpty, keySet, putAll, toString, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode, isEmpty, keySet, putAll, values

Constructor Detail

ConcurrentLinkedHashMap

public ConcurrentLinkedHashMap(ConcurrentLinkedHashMap.EvictionPolicy policy,
                       int maximumCapacity,
                       ConcurrentLinkedHashMap.EvictionListener<K,V>... listeners)

Creates a new, empty, unbounded map with the specified maximum capacity and the default concurrencyLevel.

Parameters:

policy - The eviction policy to apply when the size exceeds the maximum capacity.

maximumCapacity - The maximum capacity to coerces to. The size may exceed it temporarily.

listeners - The listeners registered for notification when an entry is evicted.

ConcurrentLinkedHashMap

public ConcurrentLinkedHashMap(ConcurrentLinkedHashMap.EvictionPolicy policy,
                       int maximumCapacity,
                       int concurrencyLevel,
                       ConcurrentLinkedHashMap.EvictionListener<K,V>... listeners)

Creates a new, empty, unbounded map with the specified maximum capacity and concurrency level.

Parameters:

policy - The eviction policy to apply when the size exceeds the maximum capacity.

maximumCapacity - The maximum capacity to coerces to. The size may exceed it temporarily.

concurrencyLevel - The estimated number of concurrently updating threads. The implementation performs internal sizing to try to accommodate this many threads.

listeners - The listeners registered for notification when an entry is evicted.

Method Detail

setCapacity

public void setCapacity(int capacity)

Sets the maximum capacity of the map and eagerly evicts entries until the it shrinks to the appropriate size.

Parameters:

capacity - The maximum capacity of the map.

capacity

public int capacity()

Retrieves the maximum capacity of the map.

Returns:

The maximum capacity.

size

public int size()

Specified by:

size in interface java.util.Map<K,V>

Overrides:

size in class java.util.AbstractMap<K,V>

clear

public void clear()

Specified by:

clear in interface java.util.Map<K,V>

Overrides:

clear in class java.util.AbstractMap<K,V>

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<K,V>

Overrides:

containsKey in class java.util.AbstractMap<K,V>

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<K,V>

Overrides:

containsValue in class java.util.AbstractMap<K,V>

get

public V get(java.lang.Object key)

Specified by:

get in interface java.util.Map<K,V>

Overrides:

get in class java.util.AbstractMap<K,V>

put

public V put(K key,
    V value)

Specified by:

put in interface java.util.Map<K,V>

Overrides:

put in class java.util.AbstractMap<K,V>

putIfAbsent

public V putIfAbsent(K key,
            V value)

Specified by:

putIfAbsent in interface java.util.concurrent.ConcurrentMap<K,V>

remove

public V remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<K,V>

Overrides:

remove in class java.util.AbstractMap<K,V>

remove

public boolean remove(java.lang.Object key,
             java.lang.Object value)

Specified by:

remove in interface java.util.concurrent.ConcurrentMap<K,V>

replace

public V replace(K key,
        V value)

Specified by:

replace in interface java.util.concurrent.ConcurrentMap<K,V>

replace

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

Specified by:

replace in interface java.util.concurrent.ConcurrentMap<K,V>

entrySet

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

Specified by:

entrySet in interface java.util.Map<K,V>

Specified by:

entrySet in class java.util.AbstractMap<K,V>