|
||||||||||
| 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
org.apache.commons.collections.bidimap.UnmodifiableOrderedBidiMap
public final class UnmodifiableOrderedBidiMap
Decorates another OrderedBidiMap to ensure it can't be altered.
| 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 |
| Method Summary | |
|---|---|
void |
clear()
|
static OrderedBidiMap |
decorate(OrderedBidiMap map)
Factory method to create an unmodifiable map. |
java.util.Set |
entrySet()
|
BidiMap |
inverseBidiMap()
Gets a view of this map where the keys and values are reversed. |
OrderedBidiMap |
inverseOrderedBidiMap()
Gets a view of this map where the keys and values are reversed. |
java.util.Set |
keySet()
|
MapIterator |
mapIterator()
Obtains a MapIterator over the map. |
OrderedMapIterator |
orderedMapIterator()
Obtains an OrderedMapIterator over the map. |
java.lang.Object |
put(java.lang.Object key,
java.lang.Object value)
Puts the key-value pair into the map, replacing any previous pair. |
void |
putAll(java.util.Map mapToCopy)
|
java.lang.Object |
remove(java.lang.Object key)
|
java.lang.Object |
removeValue(java.lang.Object value)
Removes the key-value pair that is currently mapped to the specified value (optional operation). |
java.util.Collection |
values()
|
| Methods inherited from class org.apache.commons.collections.bidimap.AbstractOrderedBidiMapDecorator |
|---|
firstKey, getOrderedBidiMap, lastKey, nextKey, previousKey |
| Methods inherited from class org.apache.commons.collections.bidimap.AbstractBidiMapDecorator |
|---|
getBidiMap, getKey |
| Methods inherited from class org.apache.commons.collections.map.AbstractMapDecorator |
|---|
containsKey, containsValue, equals, get, getMap, hashCode, isEmpty, size, toString |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org.apache.commons.collections.BidiMap |
|---|
getKey |
| Methods inherited from interface java.util.Map |
|---|
containsKey, containsValue, equals, get, hashCode, isEmpty, size |
| Methods inherited from interface java.util.Map |
|---|
containsKey, containsValue, equals, get, hashCode, isEmpty, size |
| Method Detail |
|---|
public static OrderedBidiMap decorate(OrderedBidiMap map)
If the map passed in is already unmodifiable, it is returned.
map - the map to decorate, must not be null
java.lang.IllegalArgumentException - if map is nullpublic void clear()
clear in interface java.util.Mapclear in class AbstractMapDecorator
public java.lang.Object put(java.lang.Object key,
java.lang.Object value)
BidiMapWhen adding a key-value pair, the value may already exist in the map against a different key. That mapping is removed, to ensure that the value only occurs once in the inverse map.
BidiMap map1 = new DualHashBidiMap();
map.put("A","B"); // contains A mapped to B, as per Map
map.put("A","C"); // contains A mapped to C, as per Map
BidiMap map2 = new DualHashBidiMap();
map.put("A","B"); // contains A mapped to B, as per Map
map.put("C","B"); // contains C mapped to B, key A is removed
put in interface java.util.Mapput in interface BidiMapput in class AbstractMapDecoratorkey - the key to storevalue - the value to store
public void putAll(java.util.Map mapToCopy)
putAll in interface java.util.MapputAll in class AbstractMapDecoratorpublic java.lang.Object remove(java.lang.Object key)
remove in interface java.util.Mapremove in class AbstractMapDecoratorpublic java.util.Set entrySet()
entrySet in interface java.util.MapentrySet in class AbstractMapDecoratorpublic java.util.Set keySet()
keySet in interface java.util.MapkeySet in class AbstractMapDecoratorpublic java.util.Collection values()
values in interface java.util.Mapvalues in class AbstractMapDecoratorpublic java.lang.Object removeValue(java.lang.Object value)
BidiMap
If the value is not contained in the map, null is returned.
Implementations should seek to make this method perform equally as well
as remove(Object).
removeValue in interface BidiMapremoveValue in class AbstractBidiMapDecoratorvalue - the value to find the key-value pair for
null if nothing removedpublic MapIterator mapIterator()
BidiMapMapIterator over the map.
A map iterator is an efficient way of iterating over maps. It does not require that the map is stored using Map Entry objects which can increase performance.
BidiMap map = new DualHashBidiMap();
MapIterator it = map.mapIterator();
while (it.hasNext()) {
Object key = it.next();
Object value = it.getValue();
it.setValue("newValue");
}
mapIterator in interface BidiMapmapIterator in interface IterableMapmapIterator in class AbstractBidiMapDecoratorpublic BidiMap inverseBidiMap()
BidiMap
Changes to one map will be visible in the other and vice versa.
This enables both directions of the map to be accessed as a Map.
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.
inverseBidiMap in interface BidiMapinverseBidiMap in interface OrderedBidiMapinverseBidiMap in class AbstractBidiMapDecoratorpublic 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 OrderedMaporderedMapIterator in class AbstractOrderedBidiMapDecoratorpublic 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 OrderedBidiMapinverseOrderedBidiMap in class AbstractOrderedBidiMapDecorator
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||