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:

java.util.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
private class	EquivalentHashMap.EntryIterator
class	EquivalentHashMap.EntrySet
private class	EquivalentHashMap.EquivalentHashMapIterator<E>
private class	EquivalentHashMap.KeyIterator
private class	EquivalentHashMap.KeySet
(package private) static class	EquivalentHashMap.MapEntry<K,V> Exported Entry for iterators
protected static class	EquivalentHashMap.Node<K,V>
private class	EquivalentHashMap.ValueIterator
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

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
private static int	DEFAULT_INITIAL_CAPACITY
private static float	DEFAULT_LOAD_FACTOR
private Equivalence<K>	keyEq
private float	loadFactor
private static int	MAXIMUM_CAPACITY
(package private) int	modCount
(package private) int	size
private EquivalentHashMap.Node<K,V>[]	table
private int	threshold
private Equivalence<V>	valueEq

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

entrySet, keySet, values

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
(package private) void	addEntry(int index, K key, V value, int hash)
void	clear()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
(package private) EquivalentHashMap.Node<K,V>	createNode(K key, V value, int hash, EquivalentHashMap.Node<K,V> currentNode)
java.util.Set<java.util.Map.Entry<K,V>>	entrySet()
boolean	equals(java.lang.Object o)
V	get(java.lang.Object key)
Equivalence<K>	getKeyEquivalence()
(package private) <T> T	getNode(java.lang.Object key)
Equivalence<V>	getValueEquivalence()
private static int	index(int hashCode, int length)
private void	init(int initialCapacity, float loadFactor)
boolean	isEmpty()
java.util.Set<K>	keySet()
(package private) java.util.Iterator<java.util.Map.Entry<K,V>>	newEntryIterator()
(package private) java.util.Iterator<K>	newKeyIterator()
(package private) java.util.Iterator<V>	newValueIterator()
V	put(K key, V value)
void	putAll(java.util.Map<? extends K,? extends V> map)
V	remove(java.lang.Object key)
(package private) <T> T	removeNode(java.lang.Object key)
(package private) void	resize(int newCapacity)
int	size()
private static int	spread(int hashCode)
(package private) void	transfer(EquivalentHashMap.Node<K,V>[] newTable)
java.util.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

Field Detail

DEFAULT_INITIAL_CAPACITY

private static final int DEFAULT_INITIAL_CAPACITY

See Also:

Constant Field Values

DEFAULT_LOAD_FACTOR

private static final float DEFAULT_LOAD_FACTOR

See Also:

Constant Field Values

MAXIMUM_CAPACITY

private static final int MAXIMUM_CAPACITY

See Also:

Constant Field Values

table

private EquivalentHashMap.Node<K,V>[] table

size

int size

threshold

private int threshold

loadFactor

private final float loadFactor

modCount

int modCount

keyEq

private final Equivalence<K> keyEq

valueEq

private final Equivalence<V> valueEq

Constructor Detail

EquivalentHashMap

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

EquivalentHashMap

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

EquivalentHashMap

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

EquivalentHashMap

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

Method Detail

init

private void init(int initialCapacity,
        float loadFactor)

size

public int size()

isEmpty

public boolean isEmpty()

containsKey

public boolean containsKey(java.lang.Object key)

containsValue

public boolean containsValue(java.lang.Object value)

get

public V get(java.lang.Object key)

getNode

<T> T getNode(java.lang.Object key)

put

public V put(K key,
    V value)

addEntry

void addEntry(int index,
            K key,
            V value,
            int hash)

createNode

EquivalentHashMap.Node<K,V> createNode(K key,
                                     V value,
                                     int hash,
                                     EquivalentHashMap.Node<K,V> currentNode)

resize

void resize(int newCapacity)

transfer

void transfer(EquivalentHashMap.Node<K,V>[] newTable)

remove

public V remove(java.lang.Object key)

removeNode

<T> T removeNode(java.lang.Object key)

putAll

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

clear

public void clear()

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface java.util.Map<K,V>

Overrides:

equals in class java.lang.Object

getKeyEquivalence

public Equivalence<K> getKeyEquivalence()

getValueEquivalence

public Equivalence<V> getValueEquivalence()

keySet

public java.util.Set<K> keySet()

newKeyIterator

java.util.Iterator<K> newKeyIterator()

newValueIterator

java.util.Iterator<V> newValueIterator()

newEntryIterator

java.util.Iterator<java.util.Map.Entry<K,V>> newEntryIterator()

values

public java.util.Collection<V> values()

entrySet

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

spread

private static int spread(int hashCode)

index

private static int index(int hashCode,
        int length)