Class AbstractOrderedMapDecorator<K,V>
java.lang.Object
org.apache.openjpa.lib.util.collections.AbstractIterableMap<K,V>
org.apache.openjpa.lib.util.collections.AbstractMapDecorator<K,V>
org.apache.openjpa.lib.util.collections.AbstractOrderedMapDecorator<K,V>
- Type Parameters:
K
- the type of the keys in this mapV
- the type of the values in this map
- All Implemented Interfaces:
Map<K,
,V> IterableMap<K,
,V> OrderedMap<K,
V>
- Direct Known Subclasses:
UnmodifiableOrderedMap
public abstract class AbstractOrderedMapDecorator<K,V>
extends AbstractMapDecorator<K,V>
implements OrderedMap<K,V>
Provides a base decorator that enables additional functionality to be added
to an OrderedMap via decoration.
Methods are forwarded directly to the decorated map.
This implementation does not perform any special processing with the map views. Instead it simply returns the set/collection from the wrapped map. This may be undesirable, for example if you are trying to write a validating implementation it would provide a loophole around the validation. But, you might want that loophole, so this class is kept simple.
- Since:
- 3.0
-
Nested Class Summary
-
Constructor Summary
ModifierConstructorDescriptionprotected
Constructor only used in deserialization, do not use otherwise.Constructor that wraps (not copies). -
Method Summary
Modifier and TypeMethodDescriptionprotected OrderedMap<K,
V> Gets the map being decorated.firstKey()
Gets the first key currently in this map.lastKey()
Gets the last key currently in this map.Obtains aMapIterator
over the map.Gets the next key after the one specified.previousKey
(K key) Gets the previous key before the one specified.Methods inherited from class org.apache.openjpa.lib.util.collections.AbstractMapDecorator
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, toString, values
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.apache.openjpa.lib.util.collections.IterableMap
clear, put, putAll
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values
-
Constructor Details
-
AbstractOrderedMapDecorator
protected AbstractOrderedMapDecorator()Constructor only used in deserialization, do not use otherwise.- Since:
- 3.1
-
AbstractOrderedMapDecorator
Constructor that wraps (not copies).- Parameters:
map
- the map to decorate, must not be null- Throws:
NullPointerException
- if the map is null
-
-
Method Details
-
decorated
Gets the map being decorated.- Overrides:
decorated
in classAbstractMapDecorator<K,
V> - Returns:
- the decorated map
-
firstKey
Description copied from interface:OrderedMap
Gets the first key currently in this map.- Specified by:
firstKey
in interfaceOrderedMap<K,
V> - Returns:
- the first key currently in this map
-
lastKey
Description copied from interface:OrderedMap
Gets the last key currently in this map.- Specified by:
lastKey
in interfaceOrderedMap<K,
V> - Returns:
- the last key currently in this map
-
nextKey
Description copied from interface:OrderedMap
Gets the next key after the one specified.- Specified by:
nextKey
in interfaceOrderedMap<K,
V> - Parameters:
key
- the key to search for next from- Returns:
- the next key, null if no match or at end
-
previousKey
Description copied from interface:OrderedMap
Gets the previous key before the one specified.- Specified by:
previousKey
in interfaceOrderedMap<K,
V> - Parameters:
key
- the key to search for previous from- Returns:
- the previous key, null if no match or at start
-
mapIterator
Description copied from class:AbstractIterableMap
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 use Map Entry objects.
IterableMap<String,Integer> map = new HashedMap<String,Integer>(); MapIterator<String,Integer> it = map.mapIterator(); while (it.hasNext()) { String key = it.next(); Integer value = it.getValue(); it.setValue(value + 1); }
- Specified by:
mapIterator
in interfaceIterableMap<K,
V> - Specified by:
mapIterator
in interfaceOrderedMap<K,
V> - Overrides:
mapIterator
in classAbstractIterableMap<K,
V> - Returns:
- a map iterator
-