org.apache.commons.collections4.bidimap.AbstractDualBidiMap<K,V>
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
public abstract class AbstractDualBidiMap<K,V>
Abstract BidiMap implemented using two maps.
An implementation can be written simply by implementing the
createBidiMap(Map, Map, BidiMap) method.
DualHashBidiMap,
DualTreeBidiMap| Nested Class Summary | |
|---|---|
protected static class |
AbstractDualBidiMap.BidiMapIterator<K,V>
Inner class MapIterator. |
protected static class |
AbstractDualBidiMap.EntrySet<K,V>
Inner class EntrySet. |
protected static class |
AbstractDualBidiMap.EntrySetIterator<K,V>
Inner class EntrySetIterator. |
protected static class |
AbstractDualBidiMap.KeySet<K>
Inner class KeySet. |
protected static class |
AbstractDualBidiMap.KeySetIterator<K>
Inner class KeySetIterator. |
protected static class |
AbstractDualBidiMap.MapEntry<K,V>
Inner class MapEntry. |
protected static class |
AbstractDualBidiMap.Values<V>
Inner class Values. |
protected static class |
AbstractDualBidiMap.ValuesIterator<V>
Inner class ValuesIterator. |
protected static class |
AbstractDualBidiMap.View<K,V,E>
Inner class View. |
| Nested classes/interfaces inherited from interface java.util.Map |
|---|
Map.Entry<K,V> |
| Constructor Summary | |
|---|---|
protected |
AbstractDualBidiMap()
Creates an empty map, initialised by createMap. |
protected |
AbstractDualBidiMap(Map<K,V> normalMap,
Map<V,K> reverseMap)
Creates an empty map using the two maps specified as storage. |
protected |
AbstractDualBidiMap(Map<K,V> normalMap,
Map<V,K> reverseMap,
BidiMap<V,K> inverseBidiMap)
Constructs a map that decorates the specified maps, used by the subclass createBidiMap implementation. |
| Method Summary | |
|---|---|
void |
clear()
|
boolean |
containsKey(Object key)
|
boolean |
containsValue(Object value)
|
protected abstract BidiMap<V,K> |
createBidiMap(Map<V,K> normalMap,
Map<K,V> reverseMap,
BidiMap<K,V> inverseMap)
Creates a new instance of the subclass. |
protected Iterator<Map.Entry<K,V>> |
createEntrySetIterator(Iterator<Map.Entry<K,V>> iterator)
Creates an entry set iterator. |
protected Iterator<K> |
createKeySetIterator(Iterator<K> iterator)
Creates a key set iterator. |
protected Iterator<V> |
createValuesIterator(Iterator<V> iterator)
Creates a values iterator. |
Set<Map.Entry<K,V>> |
entrySet()
Gets an entrySet view of the map. |
boolean |
equals(Object obj)
|
V |
get(Object key)
|
K |
getKey(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()
|
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(Map<? extends K,? extends V> map)
|
V |
remove(Object key)
|
K |
removeValue(Object value)
Removes the key-value pair that is currently mapped to the specified value (optional operation). |
int |
size()
|
String |
toString()
|
Collection<V> |
values()
Gets a values view of the map. |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
protected AbstractDualBidiMap()
createMap.
This constructor remains in place for deserialization.
All other usage is deprecated in favour of
AbstractDualBidiMap(Map, Map).
protected AbstractDualBidiMap(Map<K,V> normalMap,
Map<V,K> reverseMap)
The two maps must be a matching pair, normal and reverse. They will typically both be empty.
Neither map is validated, so nulls may be passed in.
If you choose to do this then the subclass constructor must populate
the maps[] instance variable itself.
normalMap - the normal direction mapreverseMap - the reverse direction map
protected AbstractDualBidiMap(Map<K,V> normalMap,
Map<V,K> reverseMap,
BidiMap<V,K> inverseBidiMap)
createBidiMap implementation.
normalMap - the normal direction mapreverseMap - the reverse direction mapinverseBidiMap - the inverse BidiMap| Method Detail |
|---|
protected abstract BidiMap<V,K> createBidiMap(Map<V,K> normalMap,
Map<K,V> reverseMap,
BidiMap<K,V> inverseMap)
normalMap - the normal direction mapreverseMap - the reverse direction mapinverseMap - this map, which is the inverse in the new map
public V get(Object key)
get in interface Map<K,V>get in interface Get<K,V>Map.get(Object)public int size()
size in interface Map<K,V>size in interface Get<K,V>Map.size()public boolean isEmpty()
isEmpty in interface Map<K,V>isEmpty in interface Get<K,V>Map.isEmpty()public boolean containsKey(Object key)
containsKey in interface Map<K,V>containsKey in interface Get<K,V>Map.containsKey(Object)public boolean equals(Object obj)
equals in interface Map<K,V>equals in class Objectpublic int hashCode()
hashCode in interface Map<K,V>hashCode in class Objectpublic String toString()
toString in class Object
public V put(K key,
V value)
BidiMapWhen 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
put in interface Map<K,V>put in interface BidiMap<K,V>put in interface Put<K,V>key - the key to storevalue - the value to store
Map.put(Object, Object)public void putAll(Map<? extends K,? extends V> map)
putAll in interface Map<K,V>putAll in interface Put<K,V>Map.putAll(Map)public V remove(Object key)
remove in interface Map<K,V>remove in interface Get<K,V>Map.remove(Object)public void clear()
clear in interface Map<K,V>clear in interface Put<K,V>Map.clear()public boolean containsValue(Object value)
containsValue in interface Map<K,V>containsValue in interface Get<K,V>Map.containsValue(Object)public MapIterator<K,V> mapIterator()
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).
mapIterator in interface IterableGet<K,V>public K getKey(Object value)
BidiMap
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).
getKey in interface BidiMap<K,V>value - the value to find the key for
null if not foundpublic K removeValue(Object value)
BidiMap
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).
removeValue in interface BidiMap<K,V>value - the value to find the key-value pair for
null if nothing removedpublic BidiMap<V,K> inverseBidiMap()
BidiMap
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.
inverseBidiMap in interface BidiMap<K,V>public Set<K> keySet()
keySet in interface Map<K,V>keySet in interface Get<K,V>Map.keySet()protected Iterator<K> createKeySetIterator(Iterator<K> iterator)
iterator - the iterator to decorate
public Collection<V> values()
values in interface Map<K,V>values in interface Get<K,V>Map.values()protected Iterator<V> createValuesIterator(Iterator<V> iterator)
iterator - the iterator to decorate
public Set<Map.Entry<K,V>> entrySet()
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).
entrySet in interface Map<K,V>entrySet in interface Get<K,V>Map.entrySet()protected Iterator<Map.Entry<K,V>> createEntrySetIterator(Iterator<Map.Entry<K,V>> iterator)
iterator - the iterator to decorate
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||