K - the type of the keys in this mapV - the type of the values in this mappublic class DualTreeBidiMap<K,V> extends AbstractDualBidiMap<K,V> implements SortedBidiMap<K,V>, Serializable
BidiMap that uses two TreeMap instances.
The setValue() method on iterators will succeed only if the new value being set is not already in the bidimap.
When considering whether to use this class, the TreeBidiMap class should
also be considered. It implements the interface using a dedicated design, and does
not store each object twice, which can save on memory use.
NOTE: From Commons Collections 3.1, all subclasses will use TreeMap
and the flawed createMap method is ignored.
| Modifier and Type | Class and Description |
|---|---|
protected static class |
DualTreeBidiMap.BidiOrderedMapIterator<K,V>
Inner class MapIterator.
|
protected static class |
DualTreeBidiMap.ViewMap<K,V>
Internal sorted map view.
|
AbstractDualBidiMap.BidiMapIterator<K,V>, AbstractDualBidiMap.EntrySet<K,V>, AbstractDualBidiMap.EntrySetIterator<K,V>, AbstractDualBidiMap.KeySet<K>, AbstractDualBidiMap.KeySetIterator<K>, AbstractDualBidiMap.MapEntry<K,V>, AbstractDualBidiMap.Values<V>, AbstractDualBidiMap.ValuesIterator<V>, AbstractDualBidiMap.View<K,V,E>| Modifier | Constructor and Description |
|---|---|
|
DualTreeBidiMap()
Creates an empty
DualTreeBidiMap |
|
DualTreeBidiMap(Comparator<? super K> keyComparator,
Comparator<? super V> valueComparator)
Constructs a
DualTreeBidiMap using the specified Comparator. |
|
DualTreeBidiMap(Map<? extends K,? extends V> map)
Constructs a
DualTreeBidiMap and copies the mappings from
specified Map. |
protected |
DualTreeBidiMap(Map<K,V> normalMap,
Map<V,K> reverseMap,
BidiMap<V,K> inverseBidiMap)
Constructs a
DualTreeBidiMap that decorates the specified maps. |
| Modifier and Type | Method and Description |
|---|---|
Comparator<? super K> |
comparator() |
protected DualTreeBidiMap<V,K> |
createBidiMap(Map<V,K> normalMap,
Map<K,V> reverseMap,
BidiMap<K,V> inverseMap)
Creates a new instance of this object.
|
K |
firstKey()
Gets the first key currently in this map.
|
SortedMap<K,V> |
headMap(K toKey) |
SortedBidiMap<V,K> |
inverseBidiMap()
Gets a view of this map where the keys and values are reversed.
|
OrderedBidiMap<V,K> |
inverseOrderedBidiMap() |
SortedBidiMap<V,K> |
inverseSortedBidiMap() |
K |
lastKey()
Gets the last key currently in this map.
|
OrderedMapIterator<K,V> |
mapIterator()
Obtains an ordered map iterator.
|
K |
nextKey(K key)
Gets the next key after the one specified.
|
K |
previousKey(K key)
Gets the previous key before the one specified.
|
SortedMap<K,V> |
subMap(K fromKey,
K toKey) |
SortedMap<K,V> |
tailMap(K fromKey) |
Comparator<? super V> |
valueComparator()
Get the comparator used for the values in the value-to-key map aspect.
|
clear, containsKey, containsValue, createEntrySetIterator, createKeySetIterator, createValuesIterator, entrySet, equals, get, getKey, hashCode, isEmpty, keySet, put, putAll, remove, removeValue, size, toString, valuesclone, finalize, getClass, notify, notifyAll, wait, wait, waitgetKey, put, removeValue, valuesclear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, sizecontainsKey, containsValue, entrySet, get, isEmpty, keySet, remove, sizepublic DualTreeBidiMap()
DualTreeBidiMappublic DualTreeBidiMap(Map<? extends K,? extends V> map)
DualTreeBidiMap and copies the mappings from
specified Map.map - the map whose mappings are to be placed in this mappublic DualTreeBidiMap(Comparator<? super K> keyComparator, Comparator<? super V> valueComparator)
DualTreeBidiMap using the specified Comparator.keyComparator - the comparatorvalueComparator - the values comparator to useprotected DualTreeBidiMap(Map<K,V> normalMap, Map<V,K> reverseMap, BidiMap<V,K> inverseBidiMap)
DualTreeBidiMap that decorates the specified maps.normalMap - the normal direction mapreverseMap - the reverse direction mapinverseBidiMap - the inverse BidiMapprotected DualTreeBidiMap<V,K> createBidiMap(Map<V,K> normalMap, Map<K,V> reverseMap, BidiMap<K,V> inverseMap)
createBidiMap in class AbstractDualBidiMap<K,V>normalMap - the normal direction mapreverseMap - the reverse direction mapinverseMap - the inverse BidiMappublic Comparator<? super K> comparator()
comparator in interface SortedMap<K,V>public Comparator<? super V> valueComparator()
SortedBidiMapvalueComparator in interface SortedBidiMap<K,V>public K firstKey()
OrderedMappublic K lastKey()
OrderedMappublic K nextKey(K key)
OrderedMapnextKey in interface OrderedMap<K,V>key - the key to search for next frompublic K previousKey(K key)
OrderedMappreviousKey in interface OrderedMap<K,V>key - the key to search for previous frompublic OrderedMapIterator<K,V> mapIterator()
This implementation copies the elements to an ArrayList in order to provide the forward/backward behaviour.
mapIterator in interface IterableGet<K,V>mapIterator in interface OrderedMap<K,V>mapIterator in class AbstractDualBidiMap<K,V>public SortedBidiMap<V,K> inverseSortedBidiMap()
public OrderedBidiMap<V,K> inverseOrderedBidiMap()
public SortedBidiMap<V,K> 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 BidiMap<K,V>inverseBidiMap in interface OrderedBidiMap<K,V>inverseBidiMap in interface SortedBidiMap<K,V>inverseBidiMap in class AbstractDualBidiMap<K,V>Copyright © 2001–2019 The Apache Software Foundation. All rights reserved.