public final class

UnmodifiableOrderedBidiMap

extends AbstractOrderedBidiMapDecorator
implements Unmodifiable
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

Class Overview

Decorates another OrderedBidiMap to ensure it can't be altered.

Summary

[Expand]
Inherited Fields
From class org.apache.commons.collections.map.AbstractMapDecorator
Public Methods
void clear()
static OrderedBidiMap decorate(OrderedBidiMap map)
Factory method to create an unmodifiable map.
Set entrySet()
BidiMap inverseBidiMap()
Gets a view of this map where the keys and values are reversed.
OrderedBidiMap inverseOrderedBidiMap()
Gets a view of this map where the keys and values are reversed.
Set keySet()
MapIterator mapIterator()
Obtains a MapIterator over the map.
OrderedMapIterator orderedMapIterator()
Obtains an OrderedMapIterator over the map.
Object put(Object key, Object value)
void putAll(Map mapToCopy)
Object remove(Object key)
Object removeValue(Object value)
Removes the key-value pair that is currently mapped to the specified value (optional operation).
Collection values()
[Expand]
Inherited Methods
From class org.apache.commons.collections.bidimap.AbstractOrderedBidiMapDecorator
From class org.apache.commons.collections.bidimap.AbstractBidiMapDecorator
From class org.apache.commons.collections.map.AbstractMapDecorator
From class java.lang.Object
From interface java.util.Map
From interface org.apache.commons.collections.BidiMap
From interface org.apache.commons.collections.IterableMap
From interface org.apache.commons.collections.OrderedBidiMap
From interface org.apache.commons.collections.OrderedMap

Public Methods

public void clear ()

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
Throws
IllegalArgumentException if map is null

public Set entrySet ()

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 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.

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. See AbstractMap.values() etc. Calling this method on the inverse map should return the original.

Returns
  • an inverted bidirectional map

public Set keySet ()

public MapIterator mapIterator ()

Obtains a MapIterator 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");
 }

Returns
  • a map iterator

public OrderedMapIterator orderedMapIterator ()

Obtains an OrderedMapIterator 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();
 }

Returns
  • a map iterator

public Object put (Object key, Object value)

public void putAll (Map mapToCopy)

public Object remove (Object 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 as remove(Object).

Parameters
value the value to find the key-value pair for
Returns
  • the key that was removed, null if nothing removed

public Collection values ()