Package org.apache.cayenne.util

## Class SoftValueMap<K,​V>

- java.lang.Object
- - java.util.AbstractMap<K,​V>
  - - org.apache.cayenne.util.SoftValueMap<K,​V>

- All Implemented Interfaces:
    `Serializable`, `Map<K,​V>`

      public class SoftValueMap<K,​V>
      extends AbstractMap<K,​V>
      implements Serializable

  Map that stores values wrapped into `SoftReference`
  Since:
    4.1
  See Also:
    `WeakValueMap`, Serialized Form

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from class java.util.AbstractMap

      `AbstractMap.SimpleEntry<K extends Object,​V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,​V extends Object>`

    - ### Nested classes/interfaces inherited from interface java.util.Map

      `Map.Entry<K extends Object,​V extends Object>`

  - ### Field Summary

    Fields
    Modifier and Type | Field | Description
    --- | --- | ---
    `protected Set<Map.Entry<K,​V>>` | `entrySet` | This is a lazily created set of entries that is essentially a view to actual data
    `protected HashMap<K,​R>` | `map` | This is a main data storage used for most operations
    `protected ReferenceQueue<V>` | `referenceQueue` |

  - ### Constructor Summary

    Constructors
    Constructor | Description
    --- | ---
    `SoftValueMap()` |
    `SoftValueMap​(int initialCapacity)` |
    `SoftValueMap​(Map<? extends K,​? extends V> m)` |

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `protected void` | `checkReferenceQueue()` | Cleanup all references collected by GC so far
    `void` | `clear()` |
    `boolean` | `containsKey​(Object key)` |
    `boolean` | `containsValue​(Object value)` |
    `Set<Map.Entry<K,​V>>` | `entrySet()` |
    `V` | `get​(Object key)` |
    `boolean` | `isEmpty()` |
    `Set<K>` | `keySet()` |
    `V` | `put​(K key, V value)` |
    `void` | `putAll​(Map<? extends K,​? extends V> m)` |
    `V` | `remove​(Object key)` |
    `int` | `size()` |
    `Collection<V>` | `values()` |

    - ### Methods inherited from class java.util.AbstractMap

      `clone, 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, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll`

- - ### Field Detail

    - #### map

          protected transient HashMap<K,​R extends Reference<V>> map

      This is a main data storage used for most operations

    - #### referenceQueue

          protected transient ReferenceQueue<V> referenceQueue

    - #### entrySet

          protected transient Set<Map.Entry<K,​V>> entrySet

      This is a lazily created set of entries that is essentially a view to actual data

  - ### Constructor Detail

    - #### SoftValueMap

          public SoftValueMap()

    - #### SoftValueMap

          public SoftValueMap​(int initialCapacity)

    - #### SoftValueMap

          public SoftValueMap​(Map<? extends K,​? extends V> m)

  - ### Method Detail

    - #### size

          public int size()

      Specified by:
        `size` in interface `Map<K,​V>`
      Overrides:
        `size` in class `AbstractMap<K,​V>`

    - #### isEmpty

          public boolean isEmpty()

      Specified by:
        `isEmpty` in interface `Map<K,​V>`
      Overrides:
        `isEmpty` in class `AbstractMap<K,​V>`

    - #### containsKey

          public boolean containsKey​(Object key)

      Specified by:
        `containsKey` in interface `Map<K,​V>`
      Overrides:
        `containsKey` in class `AbstractMap<K,​V>`

    - #### containsValue

          public boolean containsValue​(Object value)

      Specified by:
        `containsValue` in interface `Map<K,​V>`
      Overrides:
        `containsValue` in class `AbstractMap<K,​V>`

    - #### get

          public V get​(Object key)

      Specified by:
        `get` in interface `Map<K,​V>`
      Overrides:
        `get` in class `AbstractMap<K,​V>`

    - #### put

          public V put​(K key,
                       V value)

      Specified by:
        `put` in interface `Map<K,​V>`
      Overrides:
        `put` in class `AbstractMap<K,​V>`

    - #### remove

          public V remove​(Object key)

      Specified by:
        `remove` in interface `Map<K,​V>`
      Overrides:
        `remove` in class `AbstractMap<K,​V>`

    - #### putAll

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

      Specified by:
        `putAll` in interface `Map<K,​V>`
      Overrides:
        `putAll` in class `AbstractMap<K,​V>`

    - #### clear

          public void clear()

      Specified by:
        `clear` in interface `Map<K,​V>`
      Overrides:
        `clear` in class `AbstractMap<K,​V>`

    - #### keySet

          public Set<K> keySet()

      Specified by:
        `keySet` in interface `Map<K,​V>`
      Overrides:
        `keySet` in class `AbstractMap<K,​V>`

    - #### values

          public Collection<V> values()

      Specified by:
        `values` in interface `Map<K,​V>`
      Overrides:
        `values` in class `AbstractMap<K,​V>`

    - #### entrySet

          public Set<Map.Entry<K,​V>> entrySet()

      Specified by:
        `entrySet` in interface `Map<K,​V>`
      Specified by:
        `entrySet` in class `AbstractMap<K,​V>`

    - #### checkReferenceQueue

          protected void checkReferenceQueue()

      Cleanup all references collected by GC so far