Package org.apache.commons.collections4.bidimap

Class UnmodifiableBidiMap<K,​V>

    • Nested Class Summary

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

        java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void clear()
      Removes all of the mappings from this map.
      java.util.Set<java.util.Map.Entry<K,​V>> entrySet()
      Gets a set view of the mappings contained in this map.
      BidiMap<V,​K> inverseBidiMap()
      Gets a view of this map where the keys and values are reversed.
      java.util.Set<K> keySet()
      Gets a view of the keys contained in this map.
      MapIterator<K,​V> mapIterator()
      Obtains a MapIterator over the map.
      V put​(K key, V value)
      Associates the specified value with the specified key in this map.
      void putAll​(java.util.Map<? extends K,​? extends V> mapToCopy)
      Copies all of the mappings from the specified map to this map.
      V remove​(java.lang.Object key)
      Remove a key-value mappings.
      K removeValue​(java.lang.Object value)
      Removes the key-value pair that is currently mapped to the specified value (optional operation).
      static <K,​V>
      BidiMap<K,​V>      		 unmodifiableBidiMap​(BidiMap<? extends K,​? extends V> map)
      Factory method to create an unmodifiable map.
      java.util.Set<V> values()
      Gets a a collection view of the values contained in this map.

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.util.Map

        compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace, replaceAll, size

    • Method Detail

      • unmodifiableBidiMap

        public static <K,​V> BidiMap<K,​V> unmodifiableBidiMap​(BidiMap<? extends K,​? extends V> map)
        Factory method to create an unmodifiable map.

        If the map passed in is already unmodifiable, it is returned.

        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        map - the map to decorate, must not be null
        Returns:
        an unmodifiable BidiMap
        Throws:
        java.lang.NullPointerException - if map is null
        Since:
        4.0

      • clear

        public void clear()
        Description copied from interface: Put
        Removes all of the mappings from this map.
        Specified by:
        clear in interface java.util.Map<K,​V>
        Specified by:
        clear in interface Put<K,​V>
        Overrides:
        clear in class AbstractMapDecorator<K,​V>
        See Also:
        Map.clear()

      • entrySet

        public java.util.Set<java.util.Map.Entry<K,​V>> entrySet()
        Description copied from interface: Get
        Gets a set view of the mappings contained in this map.
        Specified by:
        entrySet in interface Get<K,​V>
        Specified by:
        entrySet in interface java.util.Map<K,​V>
        Overrides:
        entrySet in class AbstractMapDecorator<K,​V>
        Returns:
        a set view of the mappings contained in this map.
        See Also:
        Map.entrySet()

      • inverseBidiMap

        public BidiMap<V,​K> inverseBidiMap()
        Description copied from interface: BidiMap
        Gets 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:
        inverseBidiMap in interface BidiMap<K,​V>
        Overrides:
        inverseBidiMap in class AbstractBidiMapDecorator<K,​V>
        Returns:
        an inverted bidirectional map

      • keySet

        public java.util.Set<K> keySet()
        Description copied from interface: Get
        Gets a view of the keys contained in this map.
        Specified by:
        keySet in interface Get<K,​V>
        Specified by:
        keySet in interface java.util.Map<K,​V>
        Overrides:
        keySet in class AbstractMapDecorator<K,​V>
        Returns:
        a set view of the keys contained in this map
        See Also:
        Map.keySet()

      • mapIterator

        public MapIterator<K,​V> mapIterator()
        Description copied from class: AbstractIterableMap
        Obtains a MapIterator 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. 

         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:
        mapIterator in interface IterableGet<K,​V>
        Overrides:
        mapIterator in class AbstractBidiMapDecorator<K,​V>
        Returns:
        a map iterator

      • put

        public V put​(K key,
             V value)
        Description copied from interface: Put
        Associates 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:
        put in interface BidiMap<K,​V>
        Specified by:
        put in interface java.util.Map<K,​V>
        Specified by:
        put in interface Put<K,​V>
        Overrides:
        put in class AbstractMapDecorator<K,​V>
        Parameters:
        key - key with which the specified value is to be associated
        value - value to be associated with the specified key
        Returns:
        the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key, if the implementation supports null values.)
        See Also:
        Map.put(Object, Object)

      • putAll

        public void putAll​(java.util.Map<? extends K,​? extends V> mapToCopy)
        Description copied from interface: Put
        Copies all of the mappings from the specified map to this map.
        Specified by:
        putAll in interface java.util.Map<K,​V>
        Specified by:
        putAll in interface Put<K,​V>
        Overrides:
        putAll in class AbstractMapDecorator<K,​V>
        Parameters:
        mapToCopy - mappings to be stored in this map
        See Also:
        Map.putAll(Map)

      • remove

        public V remove​(java.lang.Object key)
        Description copied from interface: Get
        Remove a key-value mappings.
        Specified by:
        remove in interface Get<K,​V>
        Specified by:
        remove in interface java.util.Map<K,​V>
        Overrides:
        remove in class AbstractMapDecorator<K,​V>
        Parameters:
        key - key whose mapping is to be removed from the map
        Returns:
        the previous value associated with key, or null if there was no mapping for key.
        See Also:
        Map.remove(Object)

      • removeValue

        public K removeValue​(java.lang.Object value)
        Description copied from interface: BidiMap
        Removes the key-value pair that is currently mapped to the specified value (optional operation).

        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).

        Specified by:
        removeValue in interface BidiMap<K,​V>
        Overrides:
        removeValue in class AbstractBidiMapDecorator<K,​V>
        Parameters:
        value - the value to find the key-value pair for
        Returns:
        the key that was removed, null if nothing removed

      • values

        public java.util.Set<V> values()
        Description copied from interface: Get
        Gets a a collection view of the values contained in this map.
        Specified by:
        values in interface BidiMap<K,​V>
        Specified by:
        values in interface Get<K,​V>
        Specified by:
        values in interface java.util.Map<K,​V>
        Overrides:
        values in class AbstractBidiMapDecorator<K,​V>
        Returns:
        a collection view of the values contained in this map.
        See Also:
        Map.values()