org.apache.commons.collections.map
Class UnmodifiableOrderedMap

java.lang.Object
  |
  +--org.apache.commons.collections.map.AbstractMapDecorator
        |
        +--org.apache.commons.collections.map.AbstractOrderedMapDecorator
              |
              +--org.apache.commons.collections.map.UnmodifiableOrderedMap
All Implemented Interfaces:
IterableMap, Map, OrderedMap, Unmodifiable

public final class UnmodifiableOrderedMap
extends AbstractOrderedMapDecorator
implements Unmodifiable

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

Since:
Commons Collections 3.0
Version:
$Revision: 1.6 $ $Date: 2004/01/14 21:43:10 $
Author:
Stephen Colebourne

Inner classes inherited from class java.util.Map
Map.Entry
 
Fields inherited from class org.apache.commons.collections.map.AbstractMapDecorator
map
 
Method Summary
 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()
           
 
Methods inherited from class org.apache.commons.collections.map.AbstractOrderedMapDecorator
firstKey, getOrderedMap, lastKey, nextKey, previousKey
 
Methods inherited from class org.apache.commons.collections.map.AbstractMapDecorator
containsKey, containsValue, equals, get, getMap, hashCode, isEmpty, size, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Map
containsKey, containsValue, equals, get, hashCode, isEmpty, size
 

Method Detail

decorate

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

mapIterator

public MapIterator mapIterator()
Description copied from interface: IterableMap
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");
 }
 
Overrides:
mapIterator in class AbstractOrderedMapDecorator
Following copied from interface: org.apache.commons.collections.IterableMap
Returns:
a map iterator

orderedMapIterator

public OrderedMapIterator orderedMapIterator()
Description copied from interface: OrderedMap
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();
 }
 
Overrides:
orderedMapIterator in class AbstractOrderedMapDecorator
Following copied from interface: org.apache.commons.collections.OrderedMap
Returns:
a map iterator

clear

public void clear()
Overrides:
clear in class AbstractMapDecorator

put

public Object put(Object key,
                  Object value)
Overrides:
put in class AbstractMapDecorator

putAll

public void putAll(Map mapToCopy)
Overrides:
putAll in class AbstractMapDecorator

remove

public Object remove(Object key)
Overrides:
remove in class AbstractMapDecorator

entrySet

public Set entrySet()
Overrides:
entrySet in class AbstractMapDecorator

keySet

public Set keySet()
Overrides:
keySet in class AbstractMapDecorator

values

public Collection values()
Overrides:
values in class AbstractMapDecorator


Copyright © 2001-2004 Apache Software Foundation. All Rights Reserved.