Class AbstractSortedMapDecorator<K,V>
- java.lang.Object
-
- org.apache.commons.collections4.map.AbstractIterableMap<K,V>
-
- org.apache.commons.collections4.map.AbstractMapDecorator<K,V>
-
- org.apache.commons.collections4.map.AbstractSortedMapDecorator<K,V>
-
- Type Parameters:
K
- the type of the keys in the mapV
- the type of the values in the map
- All Implemented Interfaces:
java.util.Map<K,V>
,java.util.SortedMap<K,V>
,Get<K,V>
,IterableGet<K,V>
,IterableMap<K,V>
,IterableSortedMap<K,V>
,OrderedMap<K,V>
,Put<K,V>
- Direct Known Subclasses:
DualTreeBidiMap.ViewMap
,FixedSizeSortedMap
,UnmodifiableSortedMap
public abstract class AbstractSortedMapDecorator<K,V> extends AbstractMapDecorator<K,V> implements IterableSortedMap<K,V>
Provides a base decorator that enables additional functionality to be added to a Map 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
- Version:
- $Id: AbstractSortedMapDecorator.java 1686855 2015-06-22 13:00:27Z tn $
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static class
AbstractSortedMapDecorator.SortedMapIterator<K,V>
OrderedMapIterator implementation.
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractSortedMapDecorator()
Constructor only used in deserialization, do not use otherwise.AbstractSortedMapDecorator(java.util.SortedMap<K,V> map)
Constructor that wraps (not copies).
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Comparator<? super K>
comparator()
protected java.util.SortedMap<K,V>
decorated()
Gets the map being decorated.K
firstKey()
Gets the first key currently in this map.java.util.SortedMap<K,V>
headMap(K toKey)
K
lastKey()
Gets the last key currently in this map.OrderedMapIterator<K,V>
mapIterator()
Obtains aMapIterator
over the map.K
nextKey(K key)
Gets the next key after the one specified.K
previousKey(K key)
Gets the previous key before the one specified.java.util.SortedMap<K,V>
subMap(K fromKey, K toKey)
java.util.SortedMap<K,V>
tailMap(K fromKey)
-
Methods inherited from class org.apache.commons.collections4.map.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.commons.collections4.Get
containsKey, containsValue, entrySet, get, isEmpty, keySet, remove, size, values
-
-
-
-
Method Detail
-
decorated
protected java.util.SortedMap<K,V> decorated()
Gets the map being decorated.- Overrides:
decorated
in classAbstractMapDecorator<K,V>
- Returns:
- the decorated map
-
comparator
public java.util.Comparator<? super K> comparator()
-
firstKey
public K firstKey()
Description copied from interface:OrderedMap
Gets the first key currently in this map.
-
lastKey
public K lastKey()
Description copied from interface:OrderedMap
Gets the last key currently in this map.
-
previousKey
public K previousKey(K key)
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
-
nextKey
public K nextKey(K key)
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
-
mapIterator
public OrderedMapIterator<K,V> mapIterator()
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
map = new HashedMap (); MapIterator it = map.mapIterator(); while (it.hasNext()) { String key = it.next(); Integer value = it.getValue(); it.setValue(value + 1); } - Specified by:
mapIterator
in interfaceIterableGet<K,V>
- Specified by:
mapIterator
in interfaceOrderedMap<K,V>
- Overrides:
mapIterator
in classAbstractIterableMap<K,V>
- Returns:
- a map iterator
-
-