public class DualTreeBidiMap extends AbstractDualBidiMap implements SortedBidiMap, java.io.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.
Constructor and Description |
---|
DualTreeBidiMap()
Creates an empty
DualTreeBidiMap |
DualTreeBidiMap(java.util.Comparator comparator)
Constructs a
DualTreeBidiMap using the specified Comparator. |
DualTreeBidiMap(java.util.Map map)
Constructs a
DualTreeBidiMap and copies the mappings from
specified Map . |
Modifier and Type | Method and Description |
---|---|
java.util.Comparator |
comparator() |
java.lang.Object |
firstKey()
Gets the first key currently in this map.
|
java.util.SortedMap |
headMap(java.lang.Object toKey) |
OrderedBidiMap |
inverseOrderedBidiMap()
Gets a view of this map where the keys and values are reversed.
|
SortedBidiMap |
inverseSortedBidiMap()
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 ordered map iterator.
|
java.lang.Object |
previousKey(java.lang.Object key)
Gets the previous key before the one specified.
|
java.util.SortedMap |
subMap(java.lang.Object fromKey,
java.lang.Object toKey) |
java.util.SortedMap |
tailMap(java.lang.Object fromKey) |
clear, containsKey, containsValue, entrySet, equals, get, getKey, hashCode, inverseBidiMap, isEmpty, keySet, mapIterator, put, putAll, remove, removeValue, size, toString, values
inverseBidiMap
getKey, mapIterator, put, removeValue
public DualTreeBidiMap()
DualTreeBidiMap
public DualTreeBidiMap(java.util.Map map)
DualTreeBidiMap
and copies the mappings from
specified Map
.map
- the map whose mappings are to be placed in this mappublic DualTreeBidiMap(java.util.Comparator comparator)
DualTreeBidiMap
using the specified Comparator.comparator
- the Comparatorpublic java.util.Comparator comparator()
comparator
in interface java.util.SortedMap
public java.lang.Object firstKey()
OrderedMap
firstKey
in interface java.util.SortedMap
firstKey
in interface OrderedMap
public java.lang.Object lastKey()
OrderedMap
lastKey
in interface java.util.SortedMap
lastKey
in interface OrderedMap
public java.lang.Object nextKey(java.lang.Object key)
OrderedMap
nextKey
in interface OrderedMap
key
- the key to search for next frompublic java.lang.Object previousKey(java.lang.Object key)
OrderedMap
previousKey
in interface OrderedMap
key
- the key to search for previous frompublic OrderedMapIterator orderedMapIterator()
This implementation copies the elements to an ArrayList in order to provide the forward/backward behaviour.
orderedMapIterator
in interface OrderedMap
public SortedBidiMap inverseSortedBidiMap()
SortedBidiMap
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 SortedMap
.
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.
The inverse map returned by inverseBidiMap()
should be the
same object as returned by this method.
inverseSortedBidiMap
in interface SortedBidiMap
public OrderedBidiMap inverseOrderedBidiMap()
OrderedBidiMap
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.
inverseOrderedBidiMap
in interface OrderedBidiMap
public java.util.SortedMap headMap(java.lang.Object toKey)
headMap
in interface java.util.SortedMap
public java.util.SortedMap tailMap(java.lang.Object fromKey)
tailMap
in interface java.util.SortedMap
public java.util.SortedMap subMap(java.lang.Object fromKey, java.lang.Object toKey)
subMap
in interface java.util.SortedMap
Copyright © 2010 - 2020 Adobe. All Rights Reserved