Package com.helger.commons.collection.map

Class AbstractSoftMap<K,V>

java.lang.Object

java.util.AbstractMap<K,V>

com.helger.commons.collection.map.AbstractSoftMap<K,V>

Type Parameters:

K - Key type

V - Value type

All Implemented Interfaces:

ICommonsMap<K,V>, ICloneable<ICommonsMap<K,V>>, Map<K,V>

Direct Known Subclasses:

SoftHashMap, SoftLinkedHashMap

public abstract class AbstractSoftMap<K,V>
extends AbstractMap<K,V>
implements ICommonsMap<K,V>

Soft Map implementation based on http://www.javaspecialists.eu/archive/Issue015.html
The entrySet implementation is from org.hypergraphdb.util
Note: AbstractSoftMap is NOT serializable!

Author:

Philip Helger

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractSoftMap.SoftValue<K,V>	We define our own subclass of SoftReference which contains not only the value but also the key to make it easier to find the entry in the HashMap after it's been garbage collected.

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 Map<K,AbstractSoftMap.SoftValue<K,V>>	m_aSrcMap	The internal HashMap that will hold the SoftReference.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSoftMap(Map<K,AbstractSoftMap.SoftValue<K,V>> aSrcMap)

Method Summary

Modifier and Type	Method	Description
void	clear()
Set<Map.Entry<K,V>>	entrySet()
boolean	equals(Object o)
V	get(Object aKey)
int	hashCode()
protected void	onEntryRemoved(K aKey)	Callback method invoked after a map entry is garbage collected
V	put(K aKey, V aValue)	Here we put the key, value pair into the HashMap using a SoftValue object.
V	remove(Object aKey)
int	size()

Methods inherited from class java.util.AbstractMap

clone, containsKey, containsValue, isEmpty, keySet, putAll, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.commons.lang.ICloneable

getClone

Methods inherited from interface com.helger.commons.collection.impl.ICommonsMap

addAll, containsAnyEntry, containsAnyKey, containsAnyValue, copyOfEntrySet, copyOfKeySet, copyOfKeySet, copyOfValues, copyOfValues, copyOfValuesMapped, copyOfValuesMapped, createInstance, findFirstEntry, findFirstKey, findFirstValue, forEach, forEachKey, forEachKey, forEachValue, forEachValue, getAsUnmodifiable, getFirstEntry, getFirstEntry, getFirstKey, getFirstKey, getFirstValue, getFirstValue, getSortedByKey, getSortedByValue, getSwappedKeyValues, isNotEmpty, put, putAll, putAll, putAllMapped, putAllMapped, putAllMapped, putIf, putIfNotNull, removeAll, removeIf, removeIfKey, removeIfValue, removeObject, setAll

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, forEach, getOrDefault, isEmpty, keySet, merge, putAll, putIfAbsent, remove, replace, replace, replaceAll, values

Field Detail

m_aSrcMap

@CodingStyleguideUnaware
protected final Map<K,AbstractSoftMap.SoftValue<K,V>> m_aSrcMap

The internal HashMap that will hold the SoftReference.

Constructor Detail

AbstractSoftMap

protected AbstractSoftMap(@Nonnull
                          Map<K,AbstractSoftMap.SoftValue<K,V>> aSrcMap)

Method Detail

onEntryRemoved

@OverrideOnDemand
protected void onEntryRemoved(K aKey)

Callback method invoked after a map entry is garbage collected

Parameters:

aKey - Key the removed key

get

public V get(Object aKey)

Specified by:

get in interface Map<K,V>

Overrides:

get in class AbstractMap<K,V>

put

public V put(K aKey,
             V aValue)

Here we put the key, value pair into the HashMap using a SoftValue object.

Specified by:

put in interface Map<K,V>

Overrides:

put in class AbstractMap<K,V>

remove

public V remove(Object aKey)

Specified by:

remove in interface Map<K,V>

Overrides:

remove in class AbstractMap<K,V>

clear

public void clear()

Specified by:

clear in interface Map<K,V>

Overrides:

clear in class AbstractMap<K,V>

size

public int size()

Specified by:

size in interface Map<K,V>

Overrides:

size in class AbstractMap<K,V>

entrySet

@ReturnsMutableObject("design")
@CodingStyleguideUnaware
public Set<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K,V>

Specified by:

entrySet in class AbstractMap<K,V>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<K,V>

Overrides:

equals in class AbstractMap<K,V>

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<K,V>

Overrides:

hashCode in class AbstractMap<K,V>