|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.collections.map.AbstractMapDecorator
org.apache.commons.collections.bidimap.AbstractBidiMapDecorator
org.apache.commons.collections.bidimap.AbstractOrderedBidiMapDecorator
public abstract class AbstractOrderedBidiMapDecorator
Provides a base decorator that enables additional functionality to be added to an OrderedBidiMap 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 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.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from interface java.util.Map |
|---|
java.util.Map.Entry |
| Nested classes/interfaces inherited from interface java.util.Map |
|---|
java.util.Map.Entry |
| Field Summary |
|---|
| Fields inherited from class org.apache.commons.collections.map.AbstractMapDecorator |
|---|
map |
| Constructor Summary | |
|---|---|
protected |
AbstractOrderedBidiMapDecorator(OrderedBidiMap map)
Constructor that wraps (not copies). |
| Method Summary | |
|---|---|
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. |
| Methods inherited from class org.apache.commons.collections.bidimap.AbstractBidiMapDecorator |
|---|
getBidiMap, getKey, inverseBidiMap, mapIterator, removeValue |
| 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 org.apache.commons.collections.OrderedBidiMap |
|---|
inverseBidiMap |
| Methods inherited from interface org.apache.commons.collections.BidiMap |
|---|
getKey, mapIterator, put, removeValue |
| Methods inherited from interface java.util.Map |
|---|
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, putAll, remove, size, values |
| Methods inherited from interface java.util.Map |
|---|
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, putAll, remove, size, values |
| Constructor Detail |
|---|
protected AbstractOrderedBidiMapDecorator(OrderedBidiMap map)
map - the map to decorate, must not be null
java.lang.IllegalArgumentException - if the collection is null| Method Detail |
|---|
protected 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()
OrderedMap
firstKey in interface OrderedMappublic java.lang.Object lastKey()
OrderedMap
lastKey in interface OrderedMappublic java.lang.Object nextKey(java.lang.Object key)
OrderedMap
nextKey in interface OrderedMapkey - the key to search for next from
public java.lang.Object previousKey(java.lang.Object key)
OrderedMap
previousKey in interface OrderedMapkey - the key to search for previous from
public 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 OrderedBidiMap
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||