Class CachingMap<T>

  • Type Parameters:
    T - the type to which SoftReferences will be kept
    All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,​java.lang.ref.SoftReference<T>>

    public class CachingMap<T>
    extends java.util.LinkedHashMap<java.lang.String,​java.lang.ref.SoftReference<T>>

    The CachingMap class offers an implementation of a LinkedHashMap that can be used for caches. The maps' values are SoftReferences, such that garbage collection can be performed on the cache, if needed.

    Read / write operations are NOT synchronised.

    See Also:
    Serialized Form
    • Nested Class Summary

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

        java.util.AbstractMap.SimpleEntry<K extends java.lang.Object,​V extends java.lang.Object>, java.util.AbstractMap.SimpleImmutableEntry<K extends java.lang.Object,​V extends java.lang.Object>
    • Constructor Summary

      Constructors 
      Constructor Description
      CachingMap​(int capacity)
      Creates a caching map with a maximum capacity equal to the capacity parameter.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected boolean removeEldestEntry​(java.util.Map.Entry<java.lang.String,​java.lang.ref.SoftReference<T>> 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

      • CachingMap

        public CachingMap​(int capacity)
        Creates a caching map with a maximum capacity equal to the capacity parameter.
        Parameters:
        capacity - the maximum capacity; if capacity < 1 then this map will always remove the latest added element
    • Method Detail

      • removeEldestEntry

        protected boolean removeEldestEntry​(java.util.Map.Entry<java.lang.String,​java.lang.ref.SoftReference<T>> eldest)
        Overrides:
        removeEldestEntry in class java.util.LinkedHashMap<java.lang.String,​java.lang.ref.SoftReference<T>>