public abstract class AbstractOrderedBidiMapDecorator extends AbstractBidiMapDecorator implements OrderedBidiMap
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 inverse 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.
map| Modifier | Constructor and Description |
|---|---|
protected |
AbstractOrderedBidiMapDecorator(OrderedBidiMap map)
Constructor that wraps (not copies).
|
| Modifier and Type | Method and Description |
|---|---|
java.lang.Object |
firstKey()
Gets the first key currently in this map.
|
protected OrderedBidiMap |
getOrderedBidiMap()
Gets the map being decorated.
|
OrderedBidiMap |
inverseOrderedBidiMap()
Gets a view of this map where the keys and values are reversed.
|
java.lang.Object |
lastKey()
Gets the last key currently in this map.
|
java.lang.Object |
nextKey(java.lang.Object key)
Gets the next key after the one specified.
|
OrderedMapIterator |
orderedMapIterator()
Obtains an
OrderedMapIterator over the map. |
java.lang.Object |
previousKey(java.lang.Object key)
Gets the previous key before the one specified.
|
getBidiMap, getKey, inverseBidiMap, mapIterator, removeValueclear, containsKey, containsValue, entrySet, equals, get, getMap, hashCode, isEmpty, keySet, put, putAll, remove, size, toString, valuesclone, finalize, getClass, notify, notifyAll, wait, wait, waitinverseBidiMapgetKey, mapIterator, put, removeValueprotected AbstractOrderedBidiMapDecorator(OrderedBidiMap map)
map - the map to decorate, must not be nulljava.lang.IllegalArgumentException - if the collection is nullprotected OrderedBidiMap getOrderedBidiMap()
public OrderedMapIterator orderedMapIterator()
OrderedMapOrderedMapIterator 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 OrderedMappublic java.lang.Object firstKey()
OrderedMapfirstKey in interface OrderedMappublic java.lang.Object lastKey()
OrderedMaplastKey in interface OrderedMappublic java.lang.Object nextKey(java.lang.Object key)
OrderedMapnextKey in interface OrderedMapkey - the key to search for next frompublic java.lang.Object previousKey(java.lang.Object key)
OrderedMappreviousKey in interface OrderedMapkey - the key to search for previous frompublic OrderedBidiMap inverseOrderedBidiMap()
OrderedBidiMapChanges to one map will be visible in the other and vice versa. This enables both directions of the map to be accessed equally.
Implementations should seek to avoid creating a new object every time this
method is called. See AbstractMap.values() etc. Calling this
method on the inverse map should return the original.
inverseOrderedBidiMap in interface OrderedBidiMapCopyright © 2001-2025 Apache Software Foundation. All Rights Reserved.