Class TreeBidiMap.Inverse

    • 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>
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.Set<java.util.Map.Entry<V,​K>> inverseEntrySet
      Store the entrySet once created.
      private java.util.Set<V> inverseKeySet
      Store the keySet once created.
      private java.util.Set<K> inverseValuesSet
      Store the valuesSet once created.
    • Constructor Summary

      Constructors 
      Constructor Description
      Inverse()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void clear()  
      boolean containsKey​(java.lang.Object key)  
      boolean containsValue​(java.lang.Object value)  
      java.util.Set<java.util.Map.Entry<V,​K>> entrySet()  
      boolean equals​(java.lang.Object obj)  
      V firstKey()
      Gets the first key currently in this map.
      K get​(java.lang.Object key)  
      V getKey​(java.lang.Object value)
      Gets the key that is currently mapped to the specified value.
      int hashCode()  
      OrderedBidiMap<K,​V> inverseBidiMap()
      Gets a view of this map where the keys and values are reversed.
      boolean isEmpty()  
      java.util.Set<V> keySet()  
      V lastKey()
      Gets the last key currently in this map.
      OrderedMapIterator<V,​K> mapIterator()
      Obtains a MapIterator over the map.
      V nextKey​(V key)
      Gets the next key after the one specified.
      V previousKey​(V key)
      Gets the previous key before the one specified.
      K put​(V key, K value)
      Puts the key-value pair into the map, replacing any previous pair.
      void putAll​(java.util.Map<? extends V,​? extends K> map)  
      K remove​(java.lang.Object key)  
      V removeValue​(java.lang.Object value)
      Removes the key-value pair that is currently mapped to the specified value (optional operation).
      int size()  
      java.lang.String toString()  
      java.util.Set<K> values()
      Returns a Set 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, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
    • Field Detail

      • inverseKeySet

        private java.util.Set<V extends java.lang.Comparable<V>> inverseKeySet
        Store the keySet once created.
      • inverseValuesSet

        private java.util.Set<K extends java.lang.Comparable<K>> inverseValuesSet
        Store the valuesSet once created.
      • inverseEntrySet

        private java.util.Set<java.util.Map.Entry<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>> inverseEntrySet
        Store the entrySet once created.
    • Constructor Detail

      • Inverse

        Inverse()
    • Method Detail

      • size

        public int size()
        Specified by:
        size in interface Get<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Specified by:
        size in interface java.util.Map<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Returns:
        the number of key-value mappings in this map
        See Also:
        Map.size()
      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface Get<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Specified by:
        isEmpty in interface java.util.Map<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Returns:
        true if this map contains no key-value mappings
        See Also:
        Map.isEmpty()
      • get

        public K get​(java.lang.Object key)
        Specified by:
        get in interface Get<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Specified by:
        get in interface java.util.Map<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Parameters:
        key - the key whose associated value is to be returned
        Returns:
        the value to which the specified key is mapped, or null if this map contains no mapping for the key
        See Also:
        Map.get(Object)
      • getKey

        public V getKey​(java.lang.Object value)
        Description copied from interface: BidiMap
        Gets the key that is currently mapped to the specified value.

        If the value is not contained in the map, null is returned.

        Implementations should seek to make this method perform equally as well as get(Object).

        Specified by:
        getKey in interface BidiMap<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Parameters:
        value - the value to find the key for
        Returns:
        the mapped key, or null if not found
      • containsKey

        public boolean containsKey​(java.lang.Object key)
        Specified by:
        containsKey in interface Get<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Specified by:
        containsKey in interface java.util.Map<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Parameters:
        key - key whose presence in this map is to be tested
        Returns:
        true if this map contains a mapping for the specified key
        See Also:
        Map.containsKey(Object)
      • containsValue

        public boolean containsValue​(java.lang.Object value)
        Specified by:
        containsValue in interface Get<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Specified by:
        containsValue in interface java.util.Map<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Parameters:
        value - value whose presence in this map is to be tested
        Returns:
        true if this map maps one or more keys to the specified value
        See Also:
        Map.containsValue(Object)
      • firstKey

        public V firstKey()
        Description copied from interface: OrderedMap
        Gets the first key currently in this map.
        Specified by:
        firstKey in interface OrderedMap<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Returns:
        the first key currently in this map
      • lastKey

        public V lastKey()
        Description copied from interface: OrderedMap
        Gets the last key currently in this map.
        Specified by:
        lastKey in interface OrderedMap<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Returns:
        the last key currently in this map
      • nextKey

        public V nextKey​(V key)
        Description copied from interface: OrderedMap
        Gets the next key after the one specified.
        Specified by:
        nextKey in interface OrderedMap<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Parameters:
        key - the key to search for next from
        Returns:
        the next key, null if no match or at end
      • previousKey

        public V previousKey​(V key)
        Description copied from interface: OrderedMap
        Gets the previous key before the one specified.
        Specified by:
        previousKey in interface OrderedMap<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Parameters:
        key - the key to search for previous from
        Returns:
        the previous key, null if no match or at start
      • put

        public K put​(V key,
                     K value)
        Description copied from interface: BidiMap
        Puts the key-value pair into the map, replacing any previous pair.

        When 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
         
        Specified by:
        put in interface BidiMap<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Specified by:
        put in interface java.util.Map<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Specified by:
        put in interface Put<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Parameters:
        key - the key to store
        value - the value to store
        Returns:
        the previous value mapped to this key
        See Also:
        Map.put(Object, Object)
      • putAll

        public void putAll​(java.util.Map<? extends V,​? extends K> map)
        Specified by:
        putAll in interface java.util.Map<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Specified by:
        putAll in interface Put<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Parameters:
        map - mappings to be stored in this map
        See Also:
        Map.putAll(Map)
      • remove

        public K remove​(java.lang.Object key)
        Specified by:
        remove in interface Get<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Specified by:
        remove in interface java.util.Map<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        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 V 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<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Parameters:
        value - the value to find the key-value pair for
        Returns:
        the key that was removed, null if nothing removed
      • clear

        public void clear()
        Specified by:
        clear in interface java.util.Map<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Specified by:
        clear in interface Put<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        See Also:
        Map.clear()
      • keySet

        public java.util.Set<V> keySet()
        Specified by:
        keySet in interface Get<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Specified by:
        keySet in interface java.util.Map<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Returns:
        a set view of the keys contained in this map
        See Also:
        Map.keySet()
      • values

        public java.util.Set<K> values()
        Description copied from interface: BidiMap
        Returns a Set view of the values contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.
        Specified by:
        values in interface BidiMap<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Specified by:
        values in interface Get<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Specified by:
        values in interface java.util.Map<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Returns:
        a set view of the values contained in this map
        See Also:
        Map.values()
      • entrySet

        public java.util.Set<java.util.Map.Entry<V,​K>> entrySet()
        Specified by:
        entrySet in interface Get<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Specified by:
        entrySet in interface java.util.Map<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Returns:
        a set view of the mappings contained in this map
        See Also:
        Map.entrySet()
      • mapIterator

        public OrderedMapIterator<V,​K> mapIterator()
        Description copied from interface: IterableGet
        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<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Specified by:
        mapIterator in interface OrderedMap<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Returns:
        a map iterator
      • inverseBidiMap

        public OrderedBidiMap<K,​V> inverseBidiMap()
        Description copied from interface: OrderedBidiMap
        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 equally.

        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.

        Implementations must return an OrderedBidiMap instance, usually by forwarding to inverseOrderedBidiMap().

        Specified by:
        inverseBidiMap in interface BidiMap<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Specified by:
        inverseBidiMap in interface OrderedBidiMap<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Returns:
        an inverted bidirectional map
      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface java.util.Map<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface java.util.Map<V extends java.lang.Comparable<V>,​K extends java.lang.Comparable<K>>
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object