public final class

UnmodifiableOrderedMap

extends AbstractOrderedMapDecorator
implements Serializable Unmodifiable
java.lang.Object
   ↳ org.apache.commons.collections.map.AbstractMapDecorator
     ↳ org.apache.commons.collections.map.AbstractOrderedMapDecorator
       ↳ org.apache.commons.collections.map.UnmodifiableOrderedMap

Class Overview

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

This class is Serializable from Commons Collections 3.1.

Summary

[Expand]
Inherited Fields
From class org.apache.commons.collections.map.AbstractMapDecorator
Public Methods
void clear()
static OrderedMap decorate(OrderedMap map)
Factory method to create an unmodifiable sorted map.
Set entrySet()
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)
Collection values()
[Expand]
Inherited Methods
From class org.apache.commons.collections.map.AbstractOrderedMapDecorator
From class org.apache.commons.collections.map.AbstractMapDecorator
From class java.lang.Object
From interface java.util.Map
From interface org.apache.commons.collections.IterableMap
From interface org.apache.commons.collections.OrderedMap

Public Methods

public void clear ()

public static OrderedMap decorate (OrderedMap map)

Factory method to create an unmodifiable sorted map.

Parameters
map the map to decorate, must not be null
Throws
IllegalArgumentException if map is null

public Set entrySet ()

public Set keySet ()

public MapIterator mapIterator ()

Obtains a MapIterator over the map.

A map iterator is an efficient way of iterating over maps. There is no need to access the entry set or cast to Map Entry objects. 

 IterableMap map = new HashedMap();
 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 Collection values ()