|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.collections.map.AbstractMapDecorator<K,V> org.apache.commons.collections.map.AbstractOrderedMapDecorator<K,V>
public abstract class AbstractOrderedMapDecorator<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.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface java.util.Map |
---|
Map.Entry<K,V> |
Field Summary |
---|
Fields inherited from class org.apache.commons.collections.map.AbstractMapDecorator |
---|
map |
Constructor Summary | |
---|---|
protected |
AbstractOrderedMapDecorator()
Constructor only used in deserialization, do not use otherwise. |
|
AbstractOrderedMapDecorator(OrderedMap<K,V> map)
Constructor that wraps (not copies). |
Method Summary | |
---|---|
K |
firstKey()
Gets the first key currently in this map. |
protected OrderedMap<K,V> |
getOrderedMap()
Gets the map being decorated. |
K |
lastKey()
Gets the last key currently in this map. |
MapIterator<K,V> |
mapIterator()
Obtains a MapIterator over the map. |
K |
nextKey(K key)
Gets the next key after the one specified. |
OrderedMapIterator<K,V> |
orderedMapIterator()
Obtains an OrderedMapIterator over the map. |
K |
previousKey(K key)
Gets the previous key before the one specified. |
Methods inherited from class org.apache.commons.collections.map.AbstractMapDecorator |
---|
clear, containsKey, containsValue, entrySet, equals, get, getMap, 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 java.util.Map |
---|
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values |
Constructor Detail |
---|
protected AbstractOrderedMapDecorator()
public AbstractOrderedMapDecorator(OrderedMap<K,V> map)
map
- the map to decorate, must not be null
IllegalArgumentException
- if the collection is nullMethod Detail |
---|
protected OrderedMap<K,V> getOrderedMap()
public K firstKey()
OrderedMap
firstKey
in interface OrderedMap<K,V>
public K lastKey()
OrderedMap
lastKey
in interface OrderedMap<K,V>
public K nextKey(K key)
OrderedMap
nextKey
in interface OrderedMap<K,V>
key
- the key to search for next from
public K previousKey(K key)
OrderedMap
previousKey
in interface OrderedMap<K,V>
key
- the key to search for previous from
public MapIterator<K,V> mapIterator()
IterableMap
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"); }
mapIterator
in interface IterableMap<K,V>
public OrderedMapIterator<K,V> orderedMapIterator()
OrderedMap
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(); }
orderedMapIterator
in interface OrderedMap<K,V>
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |