org.apache.commons.collections.map

Class UnmodifiableOrderedMap

Implemented Interfaces:
Map, Serializable, IterableMap, OrderedMap, Unmodifiable

public final class UnmodifiableOrderedMap
extends AbstractOrderedMapDecorator
implements Unmodifiable, Serializable

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

This class is Serializable from Commons Collections 3.1.

Version:
$Revision: 1.8 $ $Date: 2004/04/09 10:46:32 $
Author:
Stephen Colebourne
Since:
Commons Collections 3.0

Field Summary

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, mapIterator, nextKey, orderedMapIterator, previousKey

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

Method Details

clear

public void clear()
Overrides:
clear in interface AbstractMapDecorator

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

entrySet

public Set entrySet()
Overrides:
entrySet in interface AbstractMapDecorator

keySet

public Set keySet()
Overrides:
keySet in interface AbstractMapDecorator

mapIterator

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");
 }
 
Specified by:
mapIterator in interface IterableMap
Overrides:
mapIterator in interface AbstractOrderedMapDecorator
Returns:
a map iterator

orderedMapIterator

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();
 }
 
Specified by:
orderedMapIterator in interface OrderedMap
Overrides:
orderedMapIterator in interface AbstractOrderedMapDecorator
Returns:
a map iterator

put

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

putAll

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

remove

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

values

public Collection values()
Overrides:
values in interface AbstractMapDecorator

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