Package com.inductiveautomation.ignition.common.util

Class SoftRefMap<K,​V>

  • All Implemented Interfaces:
    java.util.Map<K,​V>
    public class SoftRefMap<K,​V>
extends java.lang.Object
implements java.util.Map<K,​V>
    A very simple cache map implementation using soft references around the keys. This class is very much NOT thread-safe, so if there is any multi- threaded use, you must wrap in Collections.synchronizedMap(). Also, containsValue(), entrySet(), and values() are not supported. This class also doesn't prune the keys for cleared references aggressivly - you can prune them yourself by calling pruneClearedReferences()
    XXX Colby says: just happened upon this... might be worth looking into replacing this class with the Google Collections MapMaker, which supports soft keys, concurrency, auto pruning, and a value generation function.

    • Nested Class Summary

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

        java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.util.Map<K,​java.lang.ref.SoftReference<V>> map  

    • Constructor Summary

      Constructors 
      Constructor Description
      SoftRefMap()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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)  
      boolean isEmpty()  
      java.util.Set<K> keySet()  
      void pruneClearedReferences()  
      V put​(K key, V value)  
      void putAll​(java.util.Map<? extends K,​? extends V> t)  
      V remove​(java.lang.Object key)  
      int size()  
      java.util.Collection<V> values()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface java.util.Map

        compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

    • Field Detail

      • map

        protected java.util.Map<K,​java.lang.ref.SoftReference<V>> map

    • Constructor Detail

      • SoftRefMap

        public SoftRefMap()

    • Method Detail

      • clear

        public void clear()
        Specified by:
        clear in interface java.util.Map<K,​V>

      • containsKey

        public boolean containsKey​(java.lang.Object key)
        Specified by:
        containsKey in interface java.util.Map<K,​V>

      • containsValue

        public boolean containsValue​(java.lang.Object value)
        Specified by:
        containsValue in interface java.util.Map<K,​V>

      • entrySet

        public java.util.Set<java.util.Map.Entry<K,​V>> entrySet()
        Specified by:
        entrySet in interface java.util.Map<K,​V>

      • values

        public java.util.Collection<V> values()
        Specified by:
        values in interface java.util.Map<K,​V>

      • pruneClearedReferences

        public void pruneClearedReferences()

      • get

        public V get​(java.lang.Object key)
        Specified by:
        get in interface java.util.Map<K,​V>

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface java.util.Map<K,​V>

      • keySet

        public java.util.Set<K> keySet()
        Specified by:
        keySet in interface java.util.Map<K,​V>

      • put

        public V put​(K key,
             V value)
        Specified by:
        put in interface java.util.Map<K,​V>

      • putAll

        public void putAll​(java.util.Map<? extends K,​? extends V> t)
        Specified by:
        putAll in interface java.util.Map<K,​V>

      • remove

        public V remove​(java.lang.Object key)
        Specified by:
        remove in interface java.util.Map<K,​V>

      • size

        public int size()
        Specified by:
        size in interface java.util.Map<K,​V>