public abstract class AbstractDualBidiMap extends Object implements BidiMap
BidiMap implemented using two maps.
An implementation can be written simply by implementing the
createMap method.
DualHashBidiMap,
DualTreeBidiMap| Modifier and Type | Class and Description |
|---|---|
protected static class |
AbstractDualBidiMap.BidiMapIterator
Inner class MapIterator.
|
protected static class |
AbstractDualBidiMap.EntrySet
Inner class EntrySet.
|
protected static class |
AbstractDualBidiMap.EntrySetIterator
Inner class EntrySetIterator.
|
protected static class |
AbstractDualBidiMap.KeySet
Inner class KeySet.
|
protected static class |
AbstractDualBidiMap.KeySetIterator
Inner class KeySetIterator.
|
protected static class |
AbstractDualBidiMap.MapEntry
Inner class MapEntry.
|
protected static class |
AbstractDualBidiMap.Values
Inner class Values.
|
protected static class |
AbstractDualBidiMap.ValuesIterator
Inner class ValuesIterator.
|
protected static class |
AbstractDualBidiMap.View
Inner class View.
|
| Modifier and Type | Field and Description |
|---|---|
protected Set |
entrySet
View of the entries.
|
protected BidiMap |
inverseBidiMap
Inverse view of this map.
|
protected Set |
keySet
View of the keys.
|
protected Map[] |
maps
Delegate map array.
|
protected Collection |
values
View of the values.
|
| Modifier | Constructor and Description |
|---|---|
protected |
AbstractDualBidiMap()
Creates an empty map, initialised by
createMap. |
protected |
AbstractDualBidiMap(Map normalMap,
Map reverseMap)
Creates an empty map using the two maps specified as storage.
|
protected |
AbstractDualBidiMap(Map normalMap,
Map reverseMap,
BidiMap inverseBidiMap)
Constructs a map that decorates the specified maps,
used by the subclass
createBidiMap implementation. |
| Modifier and Type | Method and Description |
|---|---|
void |
clear() |
boolean |
containsKey(Object key) |
boolean |
containsValue(Object value) |
protected abstract BidiMap |
createBidiMap(Map normalMap,
Map reverseMap,
BidiMap inverseMap)
Creates a new instance of the subclass.
|
protected Iterator |
createEntrySetIterator(Iterator iterator)
Creates an entry set iterator.
|
protected Iterator |
createKeySetIterator(Iterator iterator)
Creates a key set iterator.
|
protected Map |
createMap()
Deprecated.
For constructors, use the new two map constructor.
For deserialization, populate the maps array directly in readObject.
|
protected Iterator |
createValuesIterator(Iterator iterator)
Creates a values iterator.
|
Set |
entrySet()
Gets an entrySet view of the map.
|
boolean |
equals(Object obj) |
Object |
get(Object key) |
Object |
getKey(Object value)
Gets the key that is currently mapped to the specified value.
|
int |
hashCode() |
BidiMap |
inverseBidiMap()
Gets a view of this map where the keys and values are reversed.
|
boolean |
isEmpty() |
Set |
keySet()
Gets a keySet view of the map.
|
MapIterator |
mapIterator()
Obtains a
MapIterator over the map. |
Object |
put(Object key,
Object value)
Puts the key-value pair into the map, replacing any previous pair.
|
void |
putAll(Map map) |
Object |
remove(Object key) |
Object |
removeValue(Object value)
Removes the key-value pair that is currently mapped to the specified
value (optional operation).
|
int |
size() |
String |
toString() |
Collection |
values()
Gets a values view of the map.
|
protected final transient Map[] maps
protected transient BidiMap inverseBidiMap
protected transient Set keySet
protected transient Collection values
protected transient Set entrySet
protected AbstractDualBidiMap()
createMap.
This constructor remains in place for deserialization.
All other usage is deprecated in favour of
AbstractDualBidiMap(Map, Map).
protected AbstractDualBidiMap(Map normalMap, Map 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 mapprotected AbstractDualBidiMap(Map normalMap, Map reverseMap, BidiMap inverseBidiMap)
createBidiMap implementation.normalMap - the normal direction mapreverseMap - the reverse direction mapinverseBidiMap - the inverse BidiMapprotected Map createMap()
This design is deeply flawed and has been deprecated. It relied on subclass data being used during a superclass constructor.
protected abstract BidiMap createBidiMap(Map normalMap, Map reverseMap, BidiMap inverseMap)
normalMap - the normal direction mapreverseMap - the reverse direction mapinverseMap - this map, which is the inverse in the new mappublic boolean containsKey(Object key)
containsKey in interface Mappublic boolean equals(Object obj)
public int hashCode()
public Object put(Object key, Object 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
public boolean containsValue(Object value)
containsValue in interface Mappublic MapIterator 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 BidiMapmapIterator in interface IterableMappublic Object 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).
public Object 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 BidiMapvalue - the value to find the key-value pair fornull if nothing removedpublic BidiMap 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 BidiMappublic Set keySet()
protected Iterator createKeySetIterator(Iterator iterator)
iterator - the iterator to decoratepublic Collection values()
protected Iterator createValuesIterator(Iterator iterator)
iterator - the iterator to decoratepublic Set 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).
Copyright © 2001–2015 The Apache Software Foundation. All rights reserved.