AbstractDualBidiMap ("The Adobe AEM Quickstart and Web Application.")

java.lang.Object
- org.apache.commons.collections4.bidimap.AbstractDualBidiMap<K,V>

All Implemented Interfaces:

java.util.Map<K,V>, BidiMap<K,V>, Get<K,V>, IterableGet<K,V>, IterableMap<K,V>, Put<K,V>

Direct Known Subclasses:

DualHashBidiMap, DualLinkedHashBidiMap, DualTreeBidiMap
```
public abstract class AbstractDualBidiMap<K,V>
extends java.lang.Object
implements BidiMap<K,V>
```
Abstract BidiMap implemented using two maps.
An implementation can be written simply by implementing the createBidiMap(Map, Map, BidiMap) method.

Since:

3.0

See Also:

DualHashBidiMap, DualTreeBidiMap

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()`
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(java.lang.Object value)`
`java.util.Set<java.util.Map.Entry<K,V>>`	`entrySet()` Gets an entrySet view of the map.
`boolean`	`equals(java.lang.Object obj)`
`V`	`get(java.lang.Object key)`
`K`	`getKey(java.lang.Object value)` Gets the key that is currently mapped to the specified value.
`int`	`hashCode()`
`BidiMap<V,K>`	`inverseBidiMap()` Gets a view of this map where the keys and values are reversed.
`boolean`	`isEmpty()`
`java.util.Set<K>`	`keySet()` Gets a keySet view of the map.
`MapIterator<K,V>`	`mapIterator()` Obtains a `MapIterator` over the map.
`V`	`put(K key, V value)` Puts the key-value pair into the map, replacing any previous pair.
`void`	`putAll(java.util.Map<? extends K,? extends V> map)`
`V`	`remove(java.lang.Object key)`
`K`	`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<V>`	`values()` Gets a values view of the map.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Method Detail
  - get
```
public V get(java.lang.Object key)
```
    Specified by:
    
    get in interface java.util.Map<K,V>
    
    Specified by:
    
    get in interface Get<K,V>
    
    See Also:
    
    Map.get(Object)
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Map<K,V>
    
    Specified by:
    
    size in interface Get<K,V>
    
    See Also:
    
    Map.size()
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface java.util.Map<K,V>
    
    Specified by:
    
    isEmpty in interface Get<K,V>
    
    See Also:
    
    Map.isEmpty()
  - containsKey
```
public boolean containsKey(java.lang.Object key)
```
    Specified by:
    
    containsKey in interface java.util.Map<K,V>
    
    Specified by:
    
    containsKey in interface Get<K,V>
    
    See Also:
    
    Map.containsKey(Object)
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Specified by:
    
    equals in interface java.util.Map<K,V>
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface java.util.Map<K,V>
    
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - put
```
public V put(K key,
             V 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 java.util.Map<K,V>
    
    Specified by:
    
    put in interface BidiMap<K,V>
    
    Specified by:
    
    put in interface Put<K,V>
    
    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 K,? extends V> map)
```
    Specified by:
    
    putAll in interface java.util.Map<K,V>
    
    Specified by:
    
    putAll in interface Put<K,V>
    
    See Also:
    
    Map.putAll(Map)
  - remove
```
public V remove(java.lang.Object key)
```
    Specified by:
    
    remove in interface java.util.Map<K,V>
    
    Specified by:
    
    remove in interface Get<K,V>
    
    See Also:
    
    Map.remove(Object)
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<K,V>
    
    Specified by:
    
    clear in interface Put<K,V>
    
    See Also:
    
    Map.clear()
  - containsValue
```
public boolean containsValue(java.lang.Object value)
```
    Specified by:
    
    containsValue in interface java.util.Map<K,V>
    
    Specified by:
    
    containsValue in interface Get<K,V>
    
    See Also:
    
    Map.containsValue(Object)
  - mapIterator
```
public MapIterator<K,V> mapIterator()
```
    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 IterableGet<K,V>
    
    Returns:
    
    a map iterator
  - getKey
```
public K 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<K,V>
    
    Parameters:
    
    value - the value to find the key for
    
    Returns:
    
    the mapped key, or null if not found
  - 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>
    
    Parameters:
    
    value - the value to find the key-value pair for
    
    Returns:
    
    the key that was removed, null if nothing removed
  - 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>
    
    Returns:
    
    an inverted bidirectional map
  - keySet
```
public java.util.Set<K> keySet()
```
    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 java.util.Map<K,V>
    
    Specified by:
    
    keySet in interface Get<K,V>
    
    Returns:
    
    the keySet view
    
    See Also:
    
    Map.keySet()
  - values
```
public java.util.Set<V> values()
```
    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 java.util.Map<K,V>
    
    Specified by:
    
    values in interface BidiMap<K,V>
    
    Specified by:
    
    values in interface Get<K,V>
    
    Returns:
    
    the values view
    
    See Also:
    
    Map.values()
  - entrySet
```
public java.util.Set<java.util.Map.Entry<K,V>> entrySet()
```
    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 java.util.Map<K,V>
    
    Specified by:
    
    entrySet in interface Get<K,V>
    
    Returns:
    
    the entrySet view
    
    See Also:
    
    Map.entrySet()

Class AbstractDualBidiMap<K,V>

Nested Class Summary

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

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Method Detail

get

size

isEmpty

containsKey

equals

hashCode

toString

put

putAll

remove

clear

containsValue

mapIterator

getKey

removeValue

inverseBidiMap

keySet

values

entrySet