|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface OrderedMap<K,V>
Defines a map that maintains order and allows both forward and backward iteration through that order.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from interface java.util.Map |
|---|
Map.Entry<K,V> |
| Method Summary | |
|---|---|
K |
firstKey()
Gets the first key currently in this map. |
K |
lastKey()
Gets the last key currently in this 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 interface org.apache.commons.collections15.IterableMap |
|---|
mapIterator |
| Methods inherited from interface java.util.Map |
|---|
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values |
| Method Detail |
|---|
OrderedMapIterator<K,V> orderedMapIterator()
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();
}
K firstKey()
NoSuchElementException - if this map is emptyK lastKey()
NoSuchElementException - if this map is emptyK nextKey(K key)
key - the key to search for next from
K previousKey(K key)
key - the key to search for previous from
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||