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:
Serializable
,Map
,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.
- Since:
- Commons Collections 3.0
- Version:
- $Revision: 646777 $ $Date: 2008-04-10 14:33:15 +0200 (Thu, 10 Apr 2008) $
- See Also:
-
Nested Class Summary
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final long
Serialization versionFields inherited from class org.apache.commons.collections.map.AbstractMapDecorator
map
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
Constructor that wraps (not copies). -
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
static OrderedMap
decorate
(OrderedMap map) Factory method to create an unmodifiable sorted map.entrySet()
keySet()
Obtains aMapIterator
over the map.Obtains anOrderedMapIterator
over the map.void
private void
Read the map in using a custom routine.values()
private void
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
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace, replaceAll, size
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerialization version- See Also:
-
-
Constructor Details
-
UnmodifiableOrderedMap
Constructor that wraps (not copies).- Parameters:
map
- the map to decorate, must not be null- Throws:
IllegalArgumentException
- if map is null
-
-
Method Details
-
decorate
Factory method to create an unmodifiable sorted map.- Parameters:
map
- the map to decorate, must not be null- Throws:
IllegalArgumentException
- if map is null
-
writeObject
Write the map out using a custom routine.- Parameters:
out
- the output stream- Throws:
IOException
- Since:
- Commons Collections 3.1
-
readObject
Read the map in using a custom routine.- Parameters:
in
- the input stream- Throws:
IOException
ClassNotFoundException
- Since:
- Commons Collections 3.1
-
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
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 interfaceMap
- Overrides:
clear
in classAbstractMapDecorator
-
put
- Specified by:
put
in interfaceMap
- Overrides:
put
in classAbstractMapDecorator
-
putAll
- Specified by:
putAll
in interfaceMap
- Overrides:
putAll
in classAbstractMapDecorator
-
remove
- Specified by:
remove
in interfaceMap
- Overrides:
remove
in classAbstractMapDecorator
-
entrySet
- Specified by:
entrySet
in interfaceMap
- Overrides:
entrySet
in classAbstractMapDecorator
-
keySet
- Specified by:
keySet
in interfaceMap
- Overrides:
keySet
in classAbstractMapDecorator
-
values
- Specified by:
values
in interfaceMap
- Overrides:
values
in classAbstractMapDecorator
-