public final class UnmodifiableSortedBidiMap<K,V> extends AbstractSortedBidiMapDecorator<K,V> implements Unmodifiable
SortedBidiMap to ensure it can't be altered.
Attempts to modify it will result in an UnsupportedOperationException.
map| Modifier and Type | Method and Description |
|---|---|
void |
clear() |
Set<Map.Entry<K,V>> |
entrySet() |
SortedMap<K,V> |
headMap(K toKey) |
SortedBidiMap<V,K> |
inverseBidiMap()
Gets a view of this map where the keys and values are reversed.
|
Set<K> |
keySet() |
OrderedMapIterator<K,V> |
mapIterator()
Obtains a
MapIterator over the map. |
V |
put(K key,
V value)
Puts the key-value pair into the map, replacing any previous pair.
|
void |
putAll(Map<? extends K,? extends V> mapToCopy) |
V |
remove(Object key) |
K |
removeValue(Object value)
Removes the key-value pair that is currently mapped to the specified
value (optional operation).
|
SortedMap<K,V> |
subMap(K fromKey,
K toKey) |
SortedMap<K,V> |
tailMap(K fromKey) |
static <K,V> SortedBidiMap<K,V> |
unmodifiableSortedBidiMap(SortedBidiMap<K,V> map)
Factory method to create an unmodifiable map.
|
Collection<V> |
values() |
comparator, decorated, valueComparatorfirstKey, lastKey, nextKey, previousKeygetKeycontainsKey, containsValue, equals, get, hashCode, isEmpty, size, toStringclone, finalize, getClass, notify, notifyAll, wait, wait, waitfirstKey, lastKey, nextKey, previousKeycontainsKey, containsValue, equals, get, hashCode, isEmpty, sizecontainsKey, containsValue, get, isEmpty, sizepublic static <K,V> SortedBidiMap<K,V> unmodifiableSortedBidiMap(SortedBidiMap<K,V> map)
If the map passed in is already unmodifiable, it is returned.
K - the key typeV - the value typemap - the map to decorate, must not be nullIllegalArgumentException - if map is nullpublic void clear()
public V put(K key, V value)
BidiMapWhen adding a key-value pair, the value may already exist in the map against a different key. That mapping is removed, to ensure that the value only occurs once in the inverse map.
BidiMap map1 = new DualHashBidiMap();
map.put("A","B"); // contains A mapped to B, as per Map
map.put("A","C"); // contains A mapped to C, as per Map
BidiMap map2 = new DualHashBidiMap();
map.put("A","B"); // contains A mapped to B, as per Map
map.put("C","B"); // contains C mapped to B, key A is removed
put in interface Map<K,V>put in interface BidiMap<K,V>put in interface Put<K,V>put in class AbstractMapDecorator<K,V>key - the key to storevalue - the value to storeMap.put(Object, Object)public Collection<V> values()
public K removeValue(Object value)
BidiMap
If the value is not contained in the map, null is returned.
Implementations should seek to make this method perform equally as well
as remove(Object).
removeValue in interface BidiMap<K,V>removeValue in class AbstractBidiMapDecorator<K,V>value - the value to find the key-value pair fornull if nothing removedpublic OrderedMapIterator<K,V> mapIterator()
AbstractIterableMapMapIterator over the map.
A map iterator is an efficient way of iterating over maps. There is no need to access the entry set or use Map Entry objects.