Class ConcurrentCommonCache<K,V>
java.lang.Object
org.codehaus.groovy.runtime.memoize.ConcurrentCommonCache<K,V>
- Type Parameters:
- K- type of the keys
- V- type of the values
- All Implemented Interfaces:
- java.io.Serializable,- java.util.Map<K,V>,- EvictableCache<K,V>,- MemoizeCache<K,V>,- ValueConvertable<V,java.lang.Object>
- Direct Known Subclasses:
- ConcurrentSoftCache
@ThreadSafe public class ConcurrentCommonCache<K,V> extends java.lang.Object implements EvictableCache<K,V>, ValueConvertable<V,java.lang.Object>, java.io.Serializable
Represents a simple key-value cache, which is thread safe and backed by a 
Map instance- Since:
- 2.5.0
- See Also:
- Serialized Form
- 
Nested Class SummaryNested classes/interfaces inherited from interface org.codehaus.groovy.runtime.memoize.EvictableCacheEvictableCache.Action<K,V,R>, EvictableCache.EvictionStrategyNested classes/interfaces inherited from interface java.util.Mapjava.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>Nested classes/interfaces inherited from interface org.codehaus.groovy.runtime.memoize.MemoizeCacheMemoizeCache.ValueProvider<K,V>
- 
Constructor SummaryConstructors Constructor Description ConcurrentCommonCache()Constructs a cache with unlimited sizeConcurrentCommonCache(int maxSize)Constructs a LRU cache with the default initial capacity(16)ConcurrentCommonCache(int initialCapacity, int maxSize)Constructs a LRU cache with the specified initial capacity and max size.ConcurrentCommonCache(int initialCapacity, int maxSize, EvictableCache.EvictionStrategy evictionStrategy)Constructs a cache with limited sizeConcurrentCommonCache(java.util.Map<K,V> map)Constructs a cache backed by the specifiedMapinstance
- 
Method SummaryModifier and Type Method Description voidcleanUpNullReferences()Invoked when some of the held SoftReferences have been evicted by the garbage collector and so should be removed from the cache.java.util.Map<K,V>clearAll()Clear the cachebooleancontainsKey(java.lang.Object key)Determines if the cache contains an entry for the specified key.booleancontainsValue(java.lang.Object value)java.lang.ObjectconvertValue(V value)convert the original value to the target valuejava.util.Set<java.util.Map.Entry<K,V>>entrySet()Vget(java.lang.Object key)Gets a value from the cacheVgetAndPut(K key, MemoizeCache.ValueProvider<? super K,? extends V> valueProvider)Try to get the value from cache.VgetAndPut(K key, MemoizeCache.ValueProvider<? super K,? extends V> valueProvider, boolean shouldCache)booleanisEmpty()java.util.Set<K>keys()Get all keys associated to cached valuesjava.util.Set<K>keySet()Vput(K key, V value)Associates the specified value with the specified key in the cache.voidputAll(java.util.Map<? extends K,? extends V> m)Vremove(java.lang.Object key)Remove the cached value by the keyintsize()Get the size of the cachejava.util.Collection<V>values()Get all cached valuesMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.codehaus.groovy.runtime.memoize.EvictableCacheclearMethods inherited from interface java.util.Mapcompute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll
- 
Constructor Details- 
ConcurrentCommonCachepublic ConcurrentCommonCache()Constructs a cache with unlimited size
- 
ConcurrentCommonCachepublic ConcurrentCommonCache(int initialCapacity, int maxSize, EvictableCache.EvictionStrategy evictionStrategy)Constructs a cache with limited size- Parameters:
- initialCapacity- initial capacity of the cache
- maxSize- max size of the cache
- evictionStrategy- LRU or FIFO, see- EvictableCache.EvictionStrategy
 
- 
ConcurrentCommonCachepublic ConcurrentCommonCache(int initialCapacity, int maxSize)Constructs a LRU cache with the specified initial capacity and max size. The LRU cache is slower thanLRUCache- Parameters:
- initialCapacity- initial capacity of the LRU cache
- maxSize- max size of the LRU cache
 
- 
ConcurrentCommonCachepublic ConcurrentCommonCache(int maxSize)Constructs a LRU cache with the default initial capacity(16)- Parameters:
- maxSize- max size of the LRU cache
- See Also:
- ConcurrentCommonCache(int, int)
 
- 
ConcurrentCommonCacheConstructs a cache backed by the specifiedMapinstance- Parameters:
- map- the- Mapinstance
 
 
- 
- 
Method Details- 
getGets a value from the cache
- 
putAssociates the specified value with the specified key in the cache.- Specified by:
- putin interface- java.util.Map<K,V>
- Specified by:
- putin interface- MemoizeCache<K,V>
- Parameters:
- key- key with which the specified value is to be associated
- value- value to be associated with the specified key
- Returns:
- null, or the old value if the key associated with the specified key.
 
- 
getAndPutTry to get the value from cache. If not found, create the value byMemoizeCache.ValueProviderand put it into the cache, at last return the value.- Specified by:
- getAndPutin interface- MemoizeCache<K,V>
- valueProvider- provide the value if the associated value not found
- Returns:
- the cached value
 
- 
getAndPutpublic V getAndPut(K key, MemoizeCache.ValueProvider<? super K,? extends V> valueProvider, boolean shouldCache)
- 
valuesGet all cached values
- 
entrySet
- 
keysGet all keys associated to cached values- Specified by:
- keysin interface- EvictableCache<K,V>
- Returns:
- all keys
 
- 
containsKeypublic boolean containsKey(java.lang.Object key)Determines if the cache contains an entry for the specified key.- Specified by:
- containsKeyin interface- EvictableCache<K,V>
- Specified by:
- containsKeyin interface- java.util.Map<K,V>
- Parameters:
- key- key whose presence in this cache is to be tested.
- Returns:
- true if the cache contains a mapping for the specified key
 
- 
containsValuepublic boolean containsValue(java.lang.Object value)
- 
sizepublic int size()Get the size of the cache
- 
isEmptypublic boolean isEmpty()
- 
removeRemove the cached value by the key
- 
putAll
- 
keySet
- 
clearAllClear the cache- Specified by:
- clearAllin interface- EvictableCache<K,V>
- Returns:
- returns the content of the cleared map
 
- 
cleanUpNullReferencespublic void cleanUpNullReferences()Invoked when some of the held SoftReferences have been evicted by the garbage collector and so should be removed from the cache. The implementation must ensure that concurrent invocations of all methods on the cache may occur from other threads and thus should protect any shared resources.- Specified by:
- cleanUpNullReferencesin interface- MemoizeCache<K,V>
 
- 
convertValueconvert the original value to the target value- Specified by:
- convertValuein interface- ValueConvertable<K,V>
- Parameters:
- value- the original value
- Returns:
- the converted value
 
 
-