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 anotherOrderedMap
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 14:33:15 +0200 (Thu, 10 Apr 2008) $
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private static long
serialVersionUID
Serialization version-
Fields inherited from class org.apache.commons.collections.map.AbstractMapDecorator
map
-
-
Constructor Summary
Constructors Modifier Constructor Description private
UnmodifiableOrderedMap(OrderedMap map)
Constructor that wraps (not copies).
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
static OrderedMap
decorate(OrderedMap map)
Factory method to create an unmodifiable sorted map.java.util.Set
entrySet()
java.util.Set
keySet()
MapIterator
mapIterator()
Obtains aMapIterator
over the map.OrderedMapIterator
orderedMapIterator()
Obtains anOrderedMapIterator
over the map.java.lang.Object
put(java.lang.Object key, java.lang.Object value)
void
putAll(java.util.Map mapToCopy)
private void
readObject(java.io.ObjectInputStream in)
Read the map in using a custom routine.java.lang.Object
remove(java.lang.Object key)
java.util.Collection
values()
private void
writeObject(java.io.ObjectOutputStream out)
Write the map out using a custom routine.-
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
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
Serialization version- See Also:
- Constant Field Values
-
-
Constructor Detail
-
UnmodifiableOrderedMap
private UnmodifiableOrderedMap(OrderedMap map)
Constructor that wraps (not copies).- Parameters:
map
- the map to decorate, must not be null- Throws:
java.lang.IllegalArgumentException
- if map is null
-
-
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:
java.lang.IllegalArgumentException
- if map is null
-
writeObject
private void writeObject(java.io.ObjectOutputStream out) throws java.io.IOException
Write the map out using a custom routine.- Parameters:
out
- the output stream- Throws:
java.io.IOException
- Since:
- Commons Collections 3.1
-
readObject
private void readObject(java.io.ObjectInputStream in) throws java.io.IOException, java.lang.ClassNotFoundException
Read the map in using a custom routine.- Parameters:
in
- the input stream- Throws:
java.io.IOException
java.lang.ClassNotFoundException
- Since:
- Commons Collections 3.1
-
mapIterator
public MapIterator mapIterator()
Description copied from interface:IterableMap
Obtains aMapIterator
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 interfaceIterableMap
- Overrides:
mapIterator
in classAbstractOrderedMapDecorator
- Returns:
- a map iterator
-
orderedMapIterator
public OrderedMapIterator orderedMapIterator()
Description copied from interface:OrderedMap
Obtains anOrderedMapIterator
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 interfaceOrderedMap
- Overrides:
orderedMapIterator
in classAbstractOrderedMapDecorator
- Returns:
- a map iterator
-
clear
public void clear()
- Specified by:
clear
in interfacejava.util.Map
- Overrides:
clear
in classAbstractMapDecorator
-
put
public java.lang.Object put(java.lang.Object key, java.lang.Object value)
- Specified by:
put
in interfacejava.util.Map
- Overrides:
put
in classAbstractMapDecorator
-
putAll
public void putAll(java.util.Map mapToCopy)
- Specified by:
putAll
in interfacejava.util.Map
- Overrides:
putAll
in classAbstractMapDecorator
-
remove
public java.lang.Object remove(java.lang.Object key)
- Specified by:
remove
in interfacejava.util.Map
- Overrides:
remove
in classAbstractMapDecorator
-
entrySet
public java.util.Set entrySet()
- Specified by:
entrySet
in interfacejava.util.Map
- Overrides:
entrySet
in classAbstractMapDecorator
-
keySet
public java.util.Set keySet()
- Specified by:
keySet
in interfacejava.util.Map
- Overrides:
keySet
in classAbstractMapDecorator
-
values
public java.util.Collection values()
- Specified by:
values
in interfacejava.util.Map
- Overrides:
values
in classAbstractMapDecorator
-
-