HashedBinaryKeyMap (dishevelled.org multi-map 2.0 API)

java.lang.Object
- org.dishevelled.multimap.impl.HashedBinaryKeyMap<K1,K2,V>

Type Parameters:

K1 - first key type

K2 - second key type

V - value type

All Implemented Interfaces:

Map<BinaryKey<K1,K2>,V>, BinaryKeyMap<K1,K2,V>
```
public final class HashedBinaryKeyMap<K1,K2,V>
extends Object
implements BinaryKeyMap<K1,K2,V>
```
Hashed implementation of BinaryKeyMap.

Author:

Michael Heuer

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description
`HashedBinaryKeyMap()` Create a new empty HashedBinaryKeyMap.
`HashedBinaryKeyMap(int initialCapacity, float loadFactor, int threshold)` Create a new empty HashedBinaryKeyMap with the specified initial capacity, load factor, and threshold.
`HashedBinaryKeyMap(Map<? extends BinaryKey<K1,K2>,? extends V> map)` Create a new HashedBinaryKeyMap with the same mappings as the specified map (copy constructor).

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Clears the map, resetting the size to zero and nullifying references to avoid garbage collection issues.
`boolean`	`containsKey(K1 key1, K2 key2)` Return true if this map contains a binary key of {`key1, key2`}.
`boolean`	`containsKey(Object key)` Checks whether the map contains the specified key.
`boolean`	`containsValue(Object value)` Checks whether the map contains the specified value.
`Set<Map.Entry<K,V>>`	`entrySet()` Gets the entrySet view of the map.
`boolean`	`equals(Object obj)` Compares this map with another.
`V`	`get(K1 key1, K2 key2)` Return the value mapped to a binary key of {`key1, key2`}, if any.
`V`	`get(Object key)` Gets the value mapped to the key specified.
`int`	`hashCode()` Gets the standard Map hashCode.
`boolean`	`isEmpty()` Checks whether the map is currently empty.
`Set<K>`	`keySet()` Gets the keySet view of the map.
`V`	`put(BinaryKey<K1,K2> key, V value)` Puts a key-value mapping into this map.
`V`	`put(K1 key1, K2 key2, V value)` Map a binary key of {`key1, key2`} to the specified value (optional operation).
`void`	`putAll(Map<? extends K,? extends V> map)` Puts all the values from the specified map into this map.
`V`	`remove(Object key)` Removes the specified mapping from this map.
`V`	`removeKey(K1 key1, K2 key2)` Remove the mapping for a binary key of {`key1, key2`} from this map if one exists (optional operation).
`int`	`size()` Gets the size of the map.
`String`	`toString()` Gets the map as a String.
`Collection<V>`	`values()` Gets the values view of the map.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

- Constructor Detail
  - HashedBinaryKeyMap
```
public HashedBinaryKeyMap()
```
    Create a new empty HashedBinaryKeyMap.
  - HashedBinaryKeyMap
```
public HashedBinaryKeyMap(int initialCapacity,
                          float loadFactor,
                          int threshold)
```
    Create a new empty HashedBinaryKeyMap with the specified initial capacity, load factor, and threshold.
    
    Parameters:
    
    initialCapacity - initial capacity
    
    loadFactor - load factor
    
    threshold - threshold
  - HashedBinaryKeyMap
```
public HashedBinaryKeyMap(Map<? extends BinaryKey<K1,K2>,? extends V> map)
```
    Create a new HashedBinaryKeyMap with the same mappings as the specified map (copy constructor).
    
    Parameters:
    
    map - map, must not be null
- Method Detail
  - containsKey
```
public boolean containsKey(K1 key1,
                           K2 key2)
```
    Description copied from interface: BinaryKeyMap
    
    Return true if this map contains a binary key of {key1, key2}.
    
    Specified by:
    
    containsKey in interface BinaryKeyMap<K1,K2,V>
    
    Parameters:
    
    key1 - first key
    
    key2 - second key
    
    Returns:
    
    true if this map contains a binary key of {key1, key2}
  - get
```
public V get(K1 key1,
             K2 key2)
```
    Description copied from interface: BinaryKeyMap
    
    Return the value mapped to a binary key of {key1, key2}, if any.
    
    Specified by:
    
    get in interface BinaryKeyMap<K1,K2,V>
    
    Parameters:
    
    key1 - first key
    
    key2 - second key
    
    Returns:
    
    the value mapped to a binary key of {key1, key2}, or null if no such mapping exists
  - put
```
public V put(K1 key1,
             K2 key2,
             V value)
```
    Description copied from interface: BinaryKeyMap
    
    Map a binary key of {key1, key2} to the specified value (optional operation).
    
    Specified by:
    
    put in interface BinaryKeyMap<K1,K2,V>
    
    Parameters:
    
    key1 - first key
    
    key2 - second key
    
    value - value
    
    Returns:
    
    the value previously mapped to a binary key of {key1, key2}, or null if no such mapping exists
  - put
```
public V put(BinaryKey<K1,K2> key,
             V value)
```
    Puts a key-value mapping into this map.
    
    Specified by:
    
    put in interface Map<BinaryKey<K1,K2>,V>
    
    Parameters:
    
    key - the key to add
    
    value - the value to add
    
    Returns:
    
    the value previously mapped to this key, null if none
  - removeKey
```
public V removeKey(K1 key1,
                   K2 key2)
```
    Description copied from interface: BinaryKeyMap
    
    Remove the mapping for a binary key of {key1, key2} from this map if one exists (optional operation).
    
    Specified by:
    
    removeKey in interface BinaryKeyMap<K1,K2,V>
    
    Parameters:
    
    key1 - first key
    
    key2 - second key
    
    Returns:
    
    the value previously mapped to a binary key of {key1, key2}, or null if no such mapping exists
  - get
```
public V get(Object key)
```
    Gets the value mapped to the key specified.
    
    Specified by:
    
    get in interface Map<K,V>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the mapped value, null if no match
  - size
```
public int size()
```
    Gets the size of the map.
    
    Specified by:
    
    size in interface Map<K,V>
    
    Returns:
    
    the size
  - isEmpty
```
public boolean isEmpty()
```
    Checks whether the map is currently empty.
    
    Specified by:
    
    isEmpty in interface Map<K,V>
    
    Returns:
    
    true if the map is currently size zero
  - containsKey
```
public boolean containsKey(Object key)
```
    Checks whether the map contains the specified key.
    
    Specified by:
    
    containsKey in interface Map<K,V>
    
    Parameters:
    
    key - the key to search for
    
    Returns:
    
    true if the map contains the key
  - containsValue
```
public boolean containsValue(Object value)
```
    Checks whether the map contains the specified value.
    
    Specified by:
    
    containsValue in interface Map<K,V>
    
    Parameters:
    
    value - the value to search for
    
    Returns:
    
    true if the map contains the value
  - putAll
```
public void putAll(Map<? extends K,? extends V> map)
```
    Puts all the values from the specified map into this map. This implementation iterates around the specified map and uses put(Object, Object).
    
    Specified by:
    
    putAll in interface Map<K,V>
    
    Parameters:
    
    map - the map to add
    
    Throws:
    
    NullPointerException - if the map is null
  - remove
```
public V remove(Object key)
```
    Removes the specified mapping from this map.
    
    Specified by:
    
    remove in interface Map<K,V>
    
    Parameters:
    
    key - the mapping to remove
    
    Returns:
    
    the value mapped to the removed key, null if key not in map
  - clear
```
public void clear()
```
    Clears the map, resetting the size to zero and nullifying references to avoid garbage collection issues.
    
    Specified by:
    
    clear in interface Map<K,V>
  - entrySet
```
public Set<Map.Entry<K,V>> entrySet()
```
    Gets the entrySet view of the map. Changes made to the view affect this map.
    
    Specified by:
    
    entrySet in interface Map<K,V>
    
    Returns:
    
    the entrySet view
  - keySet
```
public Set<K> keySet()
```
    Gets the keySet view of the map. Changes made to the view affect this map.
    
    Specified by:
    
    keySet in interface Map<K,V>
    
    Returns:
    
    the keySet view
  - values
```
public Collection<V> values()
```
    Gets the values view of the map. Changes made to the view affect this map.
    
    Specified by:
    
    values in interface Map<K,V>
    
    Returns:
    
    the values view
  - equals
```
public boolean equals(Object obj)
```
    Compares this map with another.
    
    Specified by:
    
    equals in interface Map<K,V>
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - the object to compare to
    
    Returns:
    
    true if equal
  - hashCode
```
public int hashCode()
```
    Gets the standard Map hashCode.
    
    Specified by:
    
    hashCode in interface Map<K,V>
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    the hash code defined in the Map interface
  - toString
```
public String toString()
```
    Gets the map as a String.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string version of the map

Class HashedBinaryKeyMap<K1,K2,V>

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

HashedBinaryKeyMap

HashedBinaryKeyMap

HashedBinaryKeyMap

Method Detail

containsKey

get

put

put

removeKey

get

size

isEmpty

containsKey

containsValue

putAll

remove

clear

entrySet

keySet

values

equals

hashCode

toString