Class UnmodifiableSortedBidiMap<K,V>
- Type Parameters:
K- the type of the keys in this mapV- the type of the values in this map
- All Implemented Interfaces:
Map<K,,V> SortedMap<K,,V> BidiMap<K,,V> Get<K,,V> IterableGet<K,,V> IterableMap<K,,V> OrderedBidiMap<K,,V> OrderedMap<K,,V> Put<K,,V> SortedBidiMap<K,,V> Unmodifiable
SortedBidiMap to ensure it can't be altered.
Attempts to modify it will result in an UnsupportedOperationException.
- Since:
- 3.0
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoidclear()Removes all of the mappings from this map.entrySet()Gets a set view of the mappings contained in this map.Gets a view of this map where the keys and values are reversed.keySet()Gets a view of the keys contained in this map.Obtains aMapIteratorover the map.Associates the specified value with the specified key in this map.voidCopies all of the mappings from the specified map to this map.Remove a key-value mappings.removeValue(Object value) Removes the key-value pair that is currently mapped to the specified value (optional operation).static <K,V> SortedBidiMap <K, V> unmodifiableSortedBidiMap(SortedBidiMap<K, ? extends V> map) Factory method to create an unmodifiable map.values()Gets a a collection view of the values contained in this map.Methods inherited from class org.apache.commons.collections4.bidimap.AbstractSortedBidiMapDecorator
comparator, decorated, valueComparatorMethods inherited from class org.apache.commons.collections4.bidimap.AbstractOrderedBidiMapDecorator
firstKey, lastKey, nextKey, previousKeyMethods inherited from class org.apache.commons.collections4.bidimap.AbstractBidiMapDecorator
getKeyMethods inherited from class org.apache.commons.collections4.map.AbstractMapDecorator
containsKey, containsValue, equals, get, hashCode, isEmpty, size, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.commons.collections4.Get
containsKey, containsValue, get, isEmpty, sizeMethods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace, replaceAll, sizeMethods inherited from interface org.apache.commons.collections4.OrderedMap
firstKey, lastKey, nextKey, previousKey
-
Method Details
-
unmodifiableSortedBidiMap
Factory method to create an unmodifiable map.If the map passed in is already unmodifiable, it is returned.
- Type Parameters:
K- the key typeV- the value type- Parameters:
map- the map to decorate, must not be null- Returns:
- an unmodifiable SortedBidiMap
- Throws:
NullPointerException- if map is null- Since:
- 4.0
-
clear
-
entrySet
Description copied from interface:GetGets a set view of the mappings contained in this map. -
headMap
-
inverseBidiMap
Description copied from interface:BidiMapGets a view of this map where the keys and values are reversed.Changes to one map will be visible in the other and vice versa. This enables both directions of the map to be accessed as a
Map.Implementations should seek to avoid creating a new object every time this method is called. See
AbstractMap.values()etc. Calling this method on the inverse map should return the original.- Specified by:
inverseBidiMapin interfaceBidiMap<K,V> - Specified by:
inverseBidiMapin interfaceOrderedBidiMap<K,V> - Specified by:
inverseBidiMapin interfaceSortedBidiMap<K,V> - Overrides:
inverseBidiMapin classAbstractSortedBidiMapDecorator<K,V> - Returns:
- an inverted bidirectional map
-
keySet
Description copied from interface:GetGets a view of the keys contained in this map. -
mapIterator
Description copied from class:AbstractIterableMapObtains aMapIteratorover 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.
IterableMap<String,Integer> map = new HashedMap<String,Integer>(); MapIterator<String,Integer> it = map.mapIterator(); while (it.hasNext()) { String key = it.next(); Integer value = it.getValue(); it.setValue(value + 1); }- Specified by:
mapIteratorin interfaceIterableGet<K,V> - Specified by:
mapIteratorin interfaceOrderedMap<K,V> - Overrides:
mapIteratorin classAbstractOrderedBidiMapDecorator<K,V> - Returns:
- a map iterator
-
put
Description copied from interface:PutAssociates the specified value with the specified key in this map.Note that the return type is Object, rather than V as in the Map interface. See the class Javadoc for further info.
- Specified by:
putin interfaceBidiMap<K,V> - Specified by:
putin interfaceMap<K,V> - Specified by:
putin interfacePut<K,V> - Overrides:
putin classAbstractMapDecorator<K,V> - Parameters:
key- key with which the specified value is to be associatedvalue- value to be associated with the specified key- Returns:
- the previous value associated with
key, ornullif there was no mapping forkey. (Anullreturn can also indicate that the map previously associatednullwithkey, if the implementation supportsnullvalues.) - See Also:
-
putAll
Description copied from interface:PutCopies all of the mappings from the specified map to this map. -
remove
Description copied from interface:GetRemove a key-value mappings.- Specified by:
removein interfaceGet<K,V> - Specified by:
removein interfaceMap<K,V> - Overrides:
removein classAbstractMapDecorator<K,V> - Parameters:
key- key whose mapping is to be removed from the map- Returns:
- the previous value associated with
key, ornullif there was no mapping forkey. - See Also:
-
removeValue
Description copied from interface:BidiMapRemoves the key-value pair that is currently mapped to the specified value (optional operation).If the value is not contained in the map,
nullis returned.Implementations should seek to make this method perform equally as well as
remove(Object).- Specified by:
removeValuein interfaceBidiMap<K,V> - Overrides:
removeValuein classAbstractBidiMapDecorator<K,V> - Parameters:
value- the value to find the key-value pair for- Returns:
- the key that was removed,
nullif nothing removed
-
subMap
-
tailMap
-
values
Description copied from interface:GetGets a a collection view of the values contained in this map.- Specified by:
valuesin interfaceBidiMap<K,V> - Specified by:
valuesin interfaceGet<K,V> - Specified by:
valuesin interfaceMap<K,V> - Specified by:
valuesin interfaceSortedMap<K,V> - Overrides:
valuesin classAbstractBidiMapDecorator<K,V> - Returns:
- a collection view of the values contained in this map.
- See Also:
-