org.dishevelled.multimap

Interface BinaryKeyMap<K1,K2,V>

Type Parameters:

K1 - first key type

K2 - second key type

V - value type

All Superinterfaces:

Map<BinaryKey<K1,K2>,V>

All Known Implementing Classes:

HashedBinaryKeyMap

public interface BinaryKeyMap<K1,K2,V>
extends Map<BinaryKey<K1,K2>,V>

Binary key map.

Author:

Michael Heuer

Nested Class Summary

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

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(K1 key1, K2 key2) Return true if this map contains a binary key of {key1, key2}.
V	get(K1 key1, K2 key2) Return the value mapped to a binary key of {key1, key2}, if any.
V	put(K1 key1, K2 key2, V value) Map a binary key of {key1, key2} to the specified value (optional operation).
V	removeKey(K1 key1, K2 key2) Remove the mapping for a binary key of {key1, key2} from this map if one exists (optional operation).

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

containsKey

boolean containsKey(K1 key1,
                    K2 key2)

Return true if this map contains a binary key of {key1, key2}.

Parameters:

key1 - first key

key2 - second key

Returns:

true if this map contains a binary key of {key1, key2}

get

V get(K1 key1,
      K2 key2)

Return the value mapped to a binary key of {key1, key2}, if any.

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

removeKey

V removeKey(K1 key1,
            K2 key2)

Remove the mapping for a binary key of {key1, key2} from this map if one exists (optional operation).

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

Throws:

UnsupportedOperationException - if the remove operation is not supported by this map

Since:

2.0

put

V put(K1 key1,
      K2 key2,
      V value)

Map a binary key of {key1, key2} to the specified value (optional operation).

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

Throws:

UnsupportedOperationException - if the put operation is not supported by this map