org.infinispan.commons.equivalence

Class EquivalentHashMap<K,V>

java.lang.Object

org.infinispan.commons.util.AbstractMap<K,V>

org.infinispan.commons.equivalence.EquivalentHashMap<K,V>

All Implemented Interfaces:

Map<K,V>

Direct Known Subclasses:

EquivalentLinkedHashMap

public class EquivalentHashMap<K,V>
extends AbstractMap<K,V>

Custom hash-based map which accepts no null keys nor null values, where equality and hash code calculations are done based on passed Equivalence function implementations for keys and values, as opposed to relying on their own equals/hashCode/toString implementations. This is handy when using key/values whose mentioned methods cannot be overriden, i.e. arrays, and in situations where users want to avoid using wrapper objects. This hash map implementation is optimised for store/retrieval rather than iteration. Internal node entries are not linked, so responsibility to link them falls on the iterators.

Since:

5.3

Author:

Galder Zamarreño

See Also:

HashMap

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	EquivalentHashMap.EntrySet
protected static class	EquivalentHashMap.Node<K,V>
class	EquivalentHashMap.Values

Nested classes/interfaces inherited from class org.infinispan.commons.util.AbstractMap

AbstractMap.SimpleEntry<K,V>

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

Map.Entry<K,V>

Field Summary

Fields inherited from class org.infinispan.commons.util.AbstractMap

entrySet, keySet, values

Constructor Summary

Constructors

Constructor and Description
EquivalentHashMap(Equivalence<? super K> keyEq, Equivalence<? super V> valueEq)
EquivalentHashMap(int initialCapacity, Equivalence<? super K> keyEq, Equivalence<? super V> valueEq)
EquivalentHashMap(int initialCapacity, float loadFactor, Equivalence<? super K> keyEq, Equivalence<? super V> valueEq)
EquivalentHashMap(Map<? extends K,? extends V> map, Equivalence<? super K> keyEq, Equivalence<? super V> valueEq)

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<K,V>>	entrySet()
boolean	equals(Object o)
V	get(Object key)
Equivalence<? super K>	getKeyEquivalence()
Equivalence<? super V>	getValueEquivalence()
boolean	isEmpty()
Set<K>	keySet()
V	put(K key, V value)
void	putAll(Map<? extends K,? extends V> map)
V	remove(Object key)
int	size()
Collection<V>	values()

Methods inherited from class org.infinispan.commons.util.AbstractMap

assertKeyNotNull, eq, hash, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

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

Constructor Detail

EquivalentHashMap

public EquivalentHashMap(Equivalence<? super K> keyEq,
                         Equivalence<? super V> valueEq)

EquivalentHashMap

public EquivalentHashMap(int initialCapacity,
                         Equivalence<? super K> keyEq,
                         Equivalence<? super V> valueEq)

EquivalentHashMap

public EquivalentHashMap(int initialCapacity,
                         float loadFactor,
                         Equivalence<? super K> keyEq,
                         Equivalence<? super V> valueEq)

EquivalentHashMap

public EquivalentHashMap(Map<? extends K,? extends V> map,
                         Equivalence<? super K> keyEq,
                         Equivalence<? super V> valueEq)

Method Detail

size

public int size()

isEmpty

public boolean isEmpty()

containsKey

public boolean containsKey(Object key)

containsValue

public boolean containsValue(Object value)

get

public V get(Object key)

put

public V put(K key,
             V value)

remove

public V remove(Object key)

putAll

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

clear

public void clear()

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<K,V>

Overrides:

equals in class Object

getKeyEquivalence

public Equivalence<? super K> getKeyEquivalence()

getValueEquivalence

public Equivalence<? super V> getValueEquivalence()

keySet

public Set<K> keySet()

values

public Collection<V> values()

entrySet

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