Package org.springframework.cache.concurrent

Class ConcurrentMapCache

    • Constructor Detail

      • ConcurrentMapCache

        public ConcurrentMapCache​(String name)
        Create a new ConcurrentMapCache with the specified name.
        Parameters:
        name - the name of the cache

      • ConcurrentMapCache

        public ConcurrentMapCache​(String name,
                          boolean allowNullValues)
        Create a new ConcurrentMapCache with the specified name.
        Parameters:
        name - the name of the cache
        allowNullValues - whether to accept and convert null values for this cache

      • ConcurrentMapCache

        public ConcurrentMapCache​(String name,
                          ConcurrentMap<Object,​Object> store,
                          boolean allowNullValues)
        Create a new ConcurrentMapCache with the specified name and the given internal ConcurrentMap to use.
        Parameters:
        name - the name of the cache
        store - the ConcurrentMap to use as an internal store
        allowNullValues - whether to allow null values (adapting them to an internal null holder value)

    • Method Detail

      • isStoreByValue

        public final boolean isStoreByValue()
        Return whether this cache stores a copy of each entry (true) or a reference (false, default). If store by value is enabled, each entry in the cache must be serializable.
        Since:
        4.3

      • getName

        public final String getName()
        Description copied from interface: Cache
        Return the cache name.

      • get

        public <T> T get​(Object key,
                 Callable<T> valueLoader)
        Description copied from interface: Cache
        Return the value to which this cache maps the specified key, obtaining that value from valueLoader if necessary. This method provides a simple substitute for the conventional "if cached, return; otherwise create, cache and return" pattern.

        If possible, implementations should ensure that the loading operation is synchronized so that the specified valueLoader is only called once in case of concurrent access on the same key.

        If the valueLoader throws an exception, it is wrapped in a Cache.ValueRetrievalException

        Parameters:
        key - the key whose associated value is to be returned
        Returns:
        the value to which this cache maps the specified key

      • put

        public void put​(Object key,
                Object value)
        Description copied from interface: Cache
        Associate the specified value with the specified key in this cache.

        If the cache previously contained a mapping for this key, the old value is replaced by the specified value.

        Parameters:
        key - the key with which the specified value is to be associated
        value - the value to be associated with the specified key

      • putIfAbsent

        public Cache.ValueWrapper putIfAbsent​(Object key,
                                      Object value)
        Description copied from interface: Cache
        Atomically associate the specified value with the specified key in this cache if it is not set already.

        This is equivalent to: 

        
 Object existingValue = cache.get(key);
 if (existingValue == null) {
     cache.put(key, value);
     return null;
 } else {
     return existingValue;
 }
        except that the action is performed atomically. While all out-of-the-box CacheManager implementations are able to perform the put atomically, the operation may also be implemented in two steps, e.g. with a check for presence and a subsequent put, in a non-atomic way. Check the documentation of the native cache implementation that you are using for more details.
        Parameters:
        key - the key with which the specified value is to be associated
        value - the value to be associated with the specified key
        Returns:
        the value to which this cache maps the specified key (which may be null itself), or also null if the cache did not contain any mapping for that key prior to this call. Returning null is therefore an indicator that the given value has been associated with the key.

      • evict

        public void evict​(Object key)
        Description copied from interface: Cache
        Evict the mapping for this key from this cache if it is present.
        Parameters:
        key - the key whose mapping is to be removed from the cache

      • clear

        public void clear()
        Description copied from interface: Cache
        Remove all mappings from the cache.