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.Commons Collections 3 is in maintenance mode. Commons Collections 4 should be used instead.AbstractBidiMap
implemented using two maps.An implementation can be written simply by implementing the
createMap
method.- Since:
- Commons Collections 3.0
- See Also:
DualHashBidiMap
,DualTreeBidiMap
-
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
clear()
Deprecated.boolean
containsKey(Object key)
Deprecated.boolean
containsValue(Object value)
Deprecated.Set
entrySet()
Deprecated.Gets an entrySet view of the map.boolean
equals(Object obj)
Deprecated.Object
get(Object key)
Deprecated.Object
getKey(Object value)
Deprecated.Gets the key that is currently mapped to the specified value.int
hashCode()
Deprecated.BidiMap
inverseBidiMap()
Deprecated.Gets a view of this map where the keys and values are reversed.boolean
isEmpty()
Deprecated.Set
keySet()
Deprecated.Gets a keySet view of the map.MapIterator
mapIterator()
Deprecated.Obtains aMapIterator
over the map.Object
put(Object key, Object value)
Deprecated.Puts the key-value pair into the map, replacing any previous pair.void
putAll(Map map)
Deprecated.Object
remove(Object key)
Deprecated.Object
removeValue(Object value)
Deprecated.Removes the key-value pair that is currently mapped to the specified value (optional operation).int
size()
Deprecated.String
toString()
Deprecated.Collection
values()
Deprecated.Gets a values view of the map.-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
-
-
Method Detail
-
containsKey
public boolean containsKey(Object key)
Deprecated.- Specified by:
containsKey
in interfaceMap
-
equals
public boolean equals(Object obj)
Deprecated.
-
hashCode
public int hashCode()
Deprecated.
-
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
-
containsValue
public boolean containsValue(Object value)
Deprecated.- Specified by:
containsValue
in interfaceMap
-
mapIterator
public MapIterator mapIterator()
Deprecated.Obtains aMapIterator
over the map. The iterator implementsResetableMapIterator
. 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 interfaceBidiMap
- Specified by:
mapIterator
in interfaceIterableMap
- 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)
.
-
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 interfaceBidiMap
- 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 interfaceBidiMap
- 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.
-
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.
-
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).
-
-