CommonCache (Groovy 6.0.0-SNAPSHOT)

org.codehaus.groovy.runtime.memoize.CommonCache

All Implemented Interfaces and Traits:

FlexibleCache, ValueConvertable, Serializable
```
public class CommonCache<K, V>
extends Object
implements FlexibleCache, ValueConvertable, Serializable
```
Represents a simple key-value cache, which is NOT thread safe and backed by a Map instance
Type Parameters:
K - type of the keys
V - type of the values
Since:
2.5.0

Field Summary

Fields
Modifiers	Name	Description
`static int`	`DEFAULT_INITIAL_CAPACITY`	The default initial capacity
`static float`	`DEFAULT_LOAD_FACTOR`	The default load factor

Constructor Summary

Constructors
Constructor and description
`CommonCache()` Constructs a cache with unlimited size
`CommonCache(int initialCapacity, int maxSize, EvictionStrategy evictionStrategy)` Constructs a cache with limited size
`CommonCache(int initialCapacity, int maxSize)` Constructs an LRU cache with the specified initial capacity and max size.
`CommonCache(int maxSize)` Constructs an LRU cache with the default initial capacity
`CommonCache(Map<K, V> map)` Constructs a cache backed by the specified Map instance

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public 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.
	`public Map<K, V>`	`clearAll()` Clear the cache Returns: returns the content of the cleared map
	`public boolean`	`containsKey(Object key)` Determines if the cache contains an entry for the specified key. Parameters: `key` - key whose presence in this cache is to be tested. Returns: true if the cache contains a mapping for the specified key
	`public boolean`	`containsValue(Object value)`
	`public Object`	`convertValue(V value)` {@inheritDoc}
	`public Set<Entry<K, V>>`	`entrySet()`
	`public V`	`get(Object key)` {@inheritDoc}
	`public V`	`getAndPut(K key, ValueProvider<? super K, ? extends V> valueProvider)` Try to get the value from cache. If not found, create the value by ValueProvider and put it into the cache, at last return the value. Parameters: `key` - the key to look up `valueProvider` - provide the value if the associated value not found Returns: the cached value
	`public V`	`getAndPut(K key, ValueProvider<? super K, ? extends V> valueProvider, boolean shouldCache)`
	`public boolean`	`isEmpty()`
	`public Set<K>`	`keySet()`
	`public Set<K>`	`keys()` Get all keys associated to cached values Returns: all keys
	`public V`	`put(K key, V value)` Associates the specified value with the specified key in the cache. 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.
	`public void`	`putAll(Map<? extends K, ? extends V> m)`
	`public V`	`remove(Object key)` Remove the cached value by the key Parameters: `key` - of the cached value Returns: returns the removed value
	`protected boolean`	`removeEldestEntry(Map.Entry<K, V> eldest)`
	`public int`	`size()` Get the size of the cache Returns: the size of the cache
	`public String`	`toString()`
	`public Collection<V>`	`values()` Get all cached values Returns: all cached values

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- Field Detail
  - public static final int DEFAULT_INITIAL_CAPACITY
    
    The default initial capacity
  - public static final float DEFAULT_LOAD_FACTOR
    
    The default load factor
- Constructor Detail
  - public CommonCache()
    
    Constructs a cache with unlimited size
  - public CommonCache(int initialCapacity, int maxSize, 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 org.codehaus.groovy.runtime.memoize.EvictableCache.EvictionStrategy
  - public CommonCache(int initialCapacity, int maxSize)
    
    Constructs an LRU cache with the specified initial capacity and max size. The LRU cache is slower than LRUCache
    Parameters:
    initialCapacity - initial capacity of the LRU cache
    maxSize - max size of the LRU cache
  - public CommonCache(int maxSize)
    
    Constructs an LRU cache with the default initial capacity
    Parameters:
    maxSize - max size of the LRU cache
    See Also:
    CommonCache(int, int)
  - public CommonCache(Map<K, V> map)
    
    Constructs a cache backed by the specified Map instance
    Parameters:
    map - the Map instance
- Method Detail
  - public 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.
  - public Map<K, V> clearAll()
    
    Clear the cache
    Returns:
    returns the content of the cleared map
  - public boolean containsKey(Object key)
    
    Determines if the cache contains an entry for the specified key.
    Parameters:
    key - key whose presence in this cache is to be tested.
    Returns:
    true if the cache contains a mapping for the specified key
  - public boolean containsValue(Object value)
  - public Object convertValue(V value)
    
    {@inheritDoc}
  - public Set<Entry<K, V>> entrySet()
  - public V get(Object key)
    
    {@inheritDoc}
  - public V getAndPut(K key, ValueProvider<? super K, ? extends V> valueProvider)
    
    Try to get the value from cache. If not found, create the value by ValueProvider and put it into the cache, at last return the value.
    Parameters:
    key - the key to look up
    valueProvider - provide the value if the associated value not found
    Returns:
    the cached value
  - public V getAndPut(K key, ValueProvider<? super K, ? extends V> valueProvider, boolean shouldCache)
  - public boolean isEmpty()
  - public Set<K> keySet()
  - public Set<K> keys()
    
    Get all keys associated to cached values
    Returns:
    all keys
  - public V put(K key, V value)
    
    Associates the specified value with the specified key in the cache.
    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.
  - public void putAll(Map<? extends K, ? extends V> m)
  - public V remove(Object key)
    
    Remove the cached value by the key
    Parameters:
    key - of the cached value
    Returns:
    returns the removed value
  - protected boolean removeEldestEntry(Map.Entry<K, V> eldest)
  - public int size()
    
    Get the size of the cache
    Returns:
    the size of the cache
  - public String toString()
  - public Collection<V> values()
    
    Get all cached values
    Returns:
    all cached values

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Java] Class CommonCache<K, V>

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final int DEFAULT_INITIAL_CAPACITY

public static final float DEFAULT_LOAD_FACTOR

Constructor Detail

public CommonCache()

public CommonCache(int initialCapacity, int maxSize, EvictionStrategy evictionStrategy)

public CommonCache(int initialCapacity, int maxSize)

public CommonCache(int maxSize)

public CommonCache(Map<K, V> map)

Method Detail

public void cleanUpNullReferences()

public Map<K, V> clearAll()

public boolean containsKey(Object key)

public boolean containsValue(Object value)

public Object convertValue(V value)

public Set<Entry<K, V>> entrySet()

public V get(Object key)

public V getAndPut(K key, ValueProvider<? super K, ? extends V> valueProvider)

public V getAndPut(K key, ValueProvider<? super K, ? extends V> valueProvider, boolean shouldCache)

public boolean isEmpty()

public Set<K> keySet()

public Set<K> keys()

public V put(K key, V value)

public void putAll(Map<? extends K, ? extends V> m)

public V remove(Object key)

protected boolean removeEldestEntry(Map.Entry<K, V> eldest)

public int size()

public String toString()

public Collection<V> values()