Package org.apache.commons.collections.bidimap

Class AbstractDualBidiMap

java.lang.Object
org.apache.commons.collections.bidimap.AbstractDualBidiMap
All Implemented Interfaces:
Map, BidiMap, IterableMap
Direct Known Subclasses:
DualHashBidiMap, DualTreeBidiMap
@Deprecated(since="2021-04-30") public abstract class AbstractDualBidiMap extends Object implements BidiMap
Deprecated.
Apache Commons Collections version 3.x is being deprecated from AEMaaCS. The upgraded version 4.4 of Commons Collections is already included as replacement. Customers are advised to upgrade to this version of the library. Please note: the package name was changed to org.apache.commons.collections4. Further note that there are AEM APIs currently exposing the old collections classes; these will be updated in upcoming releases.
Abstract BidiMap implemented using two maps.

An implementation can be written simply by implementing the createMap method.

Since:
Commons Collections 3.0
See Also:

  • Method Details

    • get

      public Object get(Object key)
      Deprecated.
      Specified by:
      get in interface Map

    • size

      public int size()
      Deprecated.
      Specified by:
      size in interface Map

    • isEmpty

      public boolean isEmpty()
      Deprecated.
      Specified by:
      isEmpty in interface Map

    • containsKey

      public boolean containsKey(Object key)
      Deprecated.
      Specified by:
      containsKey in interface Map

    • equals

      public boolean equals(Object obj)
      Deprecated.
      Specified by:
      equals in interface Map
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Deprecated.
      Specified by:
      hashCode in interface Map
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class Object

    • put

      public Object put(Object key, Object value)
      Deprecated.
      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
      Specified by:
      put in interface Map
      Parameters:
      key - the key to store
      value - the value to store
      Returns:
      the previous value mapped to this key

    • putAll

      public void putAll(Map map)
      Deprecated.
      Specified by:
      putAll in interface Map

    • remove

      public Object remove(Object key)
      Deprecated.
      Specified by:
      remove in interface Map

    • clear

      public void clear()
      Deprecated.
      Specified by:
      clear in interface Map

    • containsValue

      public boolean containsValue(Object value)
      Deprecated.
      Specified by:
      containsValue in interface Map

    • mapIterator

      public MapIterator mapIterator()
      Deprecated.
      Obtains a MapIterator over the map. The iterator implements ResetableMapIterator. This implementation relies on the entrySet iterator.

      The setValue() methods only allow a new value to be set. If the value being set is already in the map, an IllegalArgumentException is thrown (as setValue cannot change the size of the map).

      Specified by:
      mapIterator in interface BidiMap
      Specified by:
      mapIterator in interface IterableMap
      Returns:
      a map iterator

    • getKey

      public Object getKey(Object value)
      Deprecated.
      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
      Parameters:
      value - the value to find the key for
      Returns:
      the mapped key, or null if not found

    • removeValue

      public Object removeValue(Object value)
      Deprecated.
      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
      Parameters:
      value - the value to find the key-value pair for
      Returns:
      the key that was removed, null if nothing removed

    • inverseBidiMap

      public BidiMap inverseBidiMap()
      Deprecated.
      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
      Returns:
      an inverted bidirectional map

    • keySet

      public Set keySet()
      Deprecated.
      Gets a keySet view of the map. Changes made on the view are reflected in the map. The set supports remove and clear but not add.
      Specified by:
      keySet in interface Map
      Returns:
      the keySet view

    • values

      public Collection values()
      Deprecated.
      Gets a values view of the map. Changes made on the view are reflected in the map. The set supports remove and clear but not add.
      Specified by:
      values in interface Map
      Returns:
      the values view

    • entrySet

      public Set entrySet()
      Deprecated.
      Gets an entrySet view of the map. Changes made on the set are reflected in the map. The set supports remove and clear but not add.

      The Map Entry setValue() method only allow a new value to be set. If the value being set is already in the map, an IllegalArgumentException is thrown (as setValue cannot change the size of the map).

      Specified by:
      entrySet in interface Map
      Returns:
      the entrySet view