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:
- java.io.Serializable, java.util.Map, IterableMap, OrderedMap, Unmodifiable
public final class UnmodifiableOrderedMap
- extends AbstractOrderedMapDecorator
- implements Unmodifiable, java.io.Serializable
Decorates another OrderedMap to ensure it can't be altered.
This class is Serializable from Commons Collections 3.1.
- Since:
- Commons Collections 3.0
- Version:
- $Revision: 646777 $ $Date: 2008-04-10 13:33:15 +0100 (Thu, 10 Apr 2008) $
- Author:
- Stephen Colebourne
- See Also:
- Serialized Form
| Nested classes/interfaces inherited from interface java.util.Map |
java.util.Map.Entry |
| 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 |
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:
java.lang.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");
}
- Specified by:
mapIterator in interface IterableMap- Overrides:
mapIterator in class AbstractOrderedMapDecorator
- 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();
}
- Specified by:
orderedMapIterator in interface OrderedMap- Overrides:
orderedMapIterator in class AbstractOrderedMapDecorator
- Returns:
- a map iterator
clear
public void clear()
- Specified by:
clear in interface java.util.Map- Overrides:
clear in class AbstractMapDecorator
put
public java.lang.Object put(java.lang.Object key,
java.lang.Object value)
- Specified by:
put in interface java.util.Map- Overrides:
put in class AbstractMapDecorator
putAll
public void putAll(java.util.Map mapToCopy)
- Specified by:
putAll in interface java.util.Map- Overrides:
putAll in class AbstractMapDecorator
remove
public java.lang.Object remove(java.lang.Object key)
- Specified by:
remove in interface java.util.Map- Overrides:
remove in class AbstractMapDecorator
entrySet
public java.util.Set entrySet()
- Specified by:
entrySet in interface java.util.Map- Overrides:
entrySet in class AbstractMapDecorator
keySet
public java.util.Set keySet()
- Specified by:
keySet in interface java.util.Map- Overrides:
keySet in class AbstractMapDecorator
values
public java.util.Collection values()
- Specified by:
values in interface java.util.Map- Overrides:
values in class AbstractMapDecorator
Copyright © 2001-2008 The Apache Software Foundation. All Rights Reserved.