java.lang.Object | |||
↳ | org.apache.commons.collections.map.AbstractMapDecorator | ||
↳ | org.apache.commons.collections.bidimap.AbstractBidiMapDecorator | ||
↳ | org.apache.commons.collections.bidimap.AbstractOrderedBidiMapDecorator |
Known Direct Subclasses |
Known Indirect Subclasses |
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.
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.commons.collections.map.AbstractMapDecorator
|
Protected Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructor that wraps (not copies).
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Gets the first key currently in this map.
| |||||||||||
Gets a view of this map where the keys and values are reversed.
| |||||||||||
Gets the last key currently in this map.
| |||||||||||
Gets the next key after the one specified.
| |||||||||||
Obtains an
OrderedMapIterator over the map. | |||||||||||
Gets the previous key before the one specified.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Gets the map being decorated.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.commons.collections.bidimap.AbstractBidiMapDecorator
| |||||||||||
From class
org.apache.commons.collections.map.AbstractMapDecorator
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
java.util.Map
| |||||||||||
From interface
org.apache.commons.collections.BidiMap
| |||||||||||
From interface
org.apache.commons.collections.IterableMap
| |||||||||||
From interface
org.apache.commons.collections.OrderedBidiMap
| |||||||||||
From interface
org.apache.commons.collections.OrderedMap
|
Constructor that wraps (not copies).
map | the map to decorate, must not be null |
---|
IllegalArgumentException | if the collection is null |
---|
Gets the first key currently in this map.
Gets a view of this map where the keys and values are reversed.
Changes 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.
Gets the last key currently in this map.
Gets the next key after the one specified.
key | the key to search for next from |
---|
Obtains an 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(); }
Gets the previous key before the one specified.
key | the key to search for previous from |
---|
Gets the map being decorated.