Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.commons.collections.map.AbstractMapDecorator
org.apache.commons.collections.bidimap.AbstractBidiMapDecorator
org.apache.commons.collections.bidimap.AbstractOrderedBidiMapDecorator
org.apache.commons.collections.bidimap.UnmodifiableOrderedBidiMap
public final class UnmodifiableOrderedBidiMap
extends AbstractOrderedBidiMapDecorator
implements Unmodifiable
OrderedBidiMap
to ensure it can't be altered.
Field Summary |
Fields inherited from class org.apache.commons.collections.map.AbstractMapDecorator | |
map |
Method Summary | |
void |
|
static OrderedBidiMap |
|
Set |
|
BidiMap |
|
OrderedBidiMap |
|
Set |
|
MapIterator |
|
OrderedMapIterator |
|
Object |
|
void |
|
Object |
|
Object |
|
Collection |
|
Methods inherited from class org.apache.commons.collections.bidimap.AbstractOrderedBidiMapDecorator | |
firstKey , getOrderedBidiMap , inverseOrderedBidiMap , lastKey , nextKey , orderedMapIterator , previousKey |
Methods inherited from class org.apache.commons.collections.bidimap.AbstractBidiMapDecorator | |
getBidiMap , getKey , inverseBidiMap , mapIterator , removeValue |
Methods inherited from class org.apache.commons.collections.map.AbstractMapDecorator | |
clear , containsKey , containsValue , entrySet , equals , get , getMap , hashCode , isEmpty , keySet , put , putAll , remove , size , toString , values |
public static OrderedBidiMap decorate(OrderedBidiMap map)
Factory method to create an unmodifiable map. If the map passed in is already unmodifiable, it is returned.
- Parameters:
map
- the map to decorate, must not be null
- Returns:
- an unmodifiable OrderedBidiMap
public BidiMap inverseBidiMap()
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 equally. Implementations should seek to avoid creating a new object every time this method is called. SeeAbstractMap.values()
etc. Calling this method on the inverse map should return the original. Implementations must return anOrderedBidiMap
instance, usually by forwarding toinverseOrderedBidiMap()
.
- Specified by:
- inverseBidiMap in interface OrderedBidiMap
- inverseBidiMap in interface BidiMap
- Overrides:
- inverseBidiMap in interface AbstractBidiMapDecorator
- Returns:
- an inverted bidirectional map
public OrderedBidiMap inverseOrderedBidiMap()
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 equally. Implementations should seek to avoid creating a new object every time this method is called. SeeAbstractMap.values()
etc. Calling this method on the inverse map should return the original.
- Specified by:
- inverseOrderedBidiMap in interface OrderedBidiMap
- Overrides:
- inverseOrderedBidiMap in interface AbstractOrderedBidiMapDecorator
- Returns:
- an inverted bidirectional map
public MapIterator mapIterator()
Obtains aMapIterator
over the map. A map iterator is an efficient way of iterating over maps. It does not require that the map is stored using Map Entry objects which can increase performance.BidiMap map = new DualHashBidiMap(); MapIterator it = map.mapIterator(); while (it.hasNext()) { Object key = it.next(); Object value = it.getValue(); it.setValue("newValue"); }
- Specified by:
- mapIterator in interface BidiMap
- mapIterator in interface IterableMap
- Overrides:
- mapIterator in interface AbstractBidiMapDecorator
- Returns:
- a map iterator
public OrderedMapIterator orderedMapIterator()
Obtains anOrderedMapIterator
over the map. A ordered map iterator is an efficient way of iterating over maps in both directions.BidiMap map = new TreeBidiMap(); MapIterator it = map.mapIterator(); while (it.hasNext()) { Object key = it.next(); Object value = it.getValue(); it.setValue("newValue"); Object previousKey = it.previous(); }
- Specified by:
- orderedMapIterator in interface OrderedMap
- Overrides:
- orderedMapIterator in interface AbstractOrderedBidiMapDecorator
- Returns:
- a map iterator
public Object put(Object key, Object value)
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
- Overrides:
- put in interface AbstractMapDecorator
- Parameters:
key
- the key to storevalue
- the value to store
- Returns:
- the previous value mapped to this key
public Object removeValue(Object value)
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 asremove(Object)
.
- Specified by:
- removeValue in interface BidiMap
- Overrides:
- removeValue in interface AbstractBidiMapDecorator
- Parameters:
value
- the value to find the key-value pair for
- Returns:
- the key that was removed,
null
if nothing removed