K - the type of keys maintained by this mapV - the type of mapped valuespublic class IndexedTreeMap<K,V> extends AbstractMap<K,V> implements IndexedNavigableMap<K,V>, Cloneable, Serializable
A Red-Black tree based NavigableMap implementation. The map is sorted according to the
natural ordering of its keys, or by a Comparator provided at map creation
time, depending on which constructor is used.
This implementation provides guaranteed log(n) time cost for the containsKey, get, put and
remove operations. Algorithms are adaptations of those in Cormen, Leiserson, and Rivest's Introduction to
Algorithms.
Note that the ordering maintained by a sorted map (whether or not an explicit comparator is provided) must be
consistent with equals if this sorted map is to correctly implement the Map interface. (See
Comparable or Comparator for a precise definition of consistent with equals.) This is so
because the Map interface is defined in terms of the equals operation, but a map performs all key
comparisons using its compareTo (or compare) method, so two keys that are deemed equal by this
method are, from the standpoint of the sorted map, equal. The behaviour of a sorted map is well-defined even if
its ordering is inconsistent with equals; it just fails to obey the general contract of the Map interface.
Note that this implementation is not synchronised. If multiple threads access a map concurrently,
and at least one of the threads modifies the map structurally, it must be synchronized externally. (A
structural modification is any operation that adds or deletes one or more mappings; merely changing the value
associated with an existing key is not a structural modification.) This is typically accomplished by synchronising on
some object that naturally encapsulates the map. If no such object exists, the map should be "wrapped" using the
Collections.synchronizedSortedMap method. This is best done at
creation time, to prevent accidental unsynchronised access to the map:
SortedMap m = Collections.synchronizedSortedMap(new IndexedTreeMap(...));
The iterators returned by the iterator method of the collections returned by all of this class's "collection
view methods" are fail-fast: if the map is structurally modified at any time after the iterator is created, in
any way except through the iterator's own remove method, the iterator will throw a
ConcurrentModificationException. Thus, in the face of concurrent modification, the iterator fails
quickly and cleanly, rather than risking arbitrary, non-deterministic behaviour at an undetermined time in the future.
Note that the fail-fast behaviour of an iterator cannot be guaranteed as it is, generally speaking, impossible to make
any hard guarantees in the presence of unsynchronised concurrent modification. Fail-fast iterators throw
ConcurrentModificationException on a best-effort basis. Therefore, it would be wrong to write a program that
depended on this exception for its correctness: the fail-fast behaviour of iterators should be used only to detect
bugs.
All Map.Entry pairs returned by methods in this class and its views represent snapshots of mappings at the
time they were produced. They do not support the Entry.setValue method. (Note however that it is
possible to change mappings in the associated map using put.)
This class is a member of the Java Collections Framework.
Map,
HashMap,
Hashtable,
Comparable,
Comparator,
Collection,
Serialized FormAbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>| Constructor and Description |
|---|
IndexedTreeMap()
Constructs a new, empty tree map, using the natural ordering of its keys.
|
IndexedTreeMap(Comparator<? super K> comparator)
Constructs a new, empty tree map, ordered according to the given comparator.
|
IndexedTreeMap(Map<? extends K,? extends V> m)
Constructs a new tree map containing the same mappings as the given map, ordered according to the natural
ordering of its keys.
|
IndexedTreeMap(SortedMap<K,? extends V> m)
Constructs a new tree map containing the same mappings and using the same ordering as the specified sorted map.
|
| Modifier and Type | Method and Description |
|---|---|
Map.Entry<K,V> |
ceilingEntry(K key) |
K |
ceilingKey(K key) |
void |
clear()
Removes all of the mappings from this map.
|
Object |
clone()
Returns a shallow copy of this
IndexedTreeMap instance. |
Comparator<? super K> |
comparator() |
boolean |
containsKey(Object key)
Returns
true if this map contains a mapping for the specified key. |
boolean |
containsValue(Object value)
Returns
true if this map maps one or more keys to the specified value. |
void |
dbg()
for debugging purposes
|
void |
debug()
for debugging purposes
|
NavigableSet<K> |
descendingKeySet() |
NavigableMap<K,V> |
descendingMap() |
Set<Map.Entry<K,V>> |
entrySet()
Returns a
Set view of the mappings contained in this map. |
de.gsi.dataset.utils.trees.IndexedTreeMap.Entry<K,V> |
exactEntry(int index)
Returns a key-value mapping associated with the key located at the index offset from the beginning
of the sorted map
|
K |
exactKey(int index)
Returns the key located at the index offset from the beginning
of the sorted map
|
static <K,V> Map.Entry<K,V> |
exportEntry(de.gsi.dataset.utils.trees.IndexedTreeMap.Entry<K,V> e)
Return SimpleImmutableEntry for entry, or null if null
|
Map.Entry<K,V> |
firstEntry() |
K |
firstKey() |
Map.Entry<K,V> |
floorEntry(K key) |
K |
floorKey(K key) |
V |
get(Object key)
Returns the value to which the specified key is mapped, or
null if this map contains no mapping for the
key. |
SortedMap<K,V> |
headMap(K toKey) |
NavigableMap<K,V> |
headMap(K toKey,
boolean inclusive) |
Map.Entry<K,V> |
higherEntry(K key) |
K |
higherKey(K key) |
static <K> K |
key(de.gsi.dataset.utils.trees.IndexedTreeMap.Entry<K,?> e)
Returns the key corresponding to the specified Entry.
|
int |
keyIndex(K key)
Searches the specified tree map for the specified key using the
put algorithm.
|
static <K,V> K |
keyOrNull(de.gsi.dataset.utils.trees.IndexedTreeMap.Entry<K,V> e)
Return key for entry, or null if null
|
Set<K> |
keySet()
Returns a
Set view of the keys contained in this map. |
Map.Entry<K,V> |
lastEntry() |
K |
lastKey() |
Map.Entry<K,V> |
lowerEntry(K key) |
K |
lowerKey(K key) |
NavigableSet<K> |
navigableKeySet() |
Map.Entry<K,V> |
pollFirstEntry() |
Map.Entry<K,V> |
pollLastEntry() |
static <K,V> de.gsi.dataset.utils.trees.IndexedTreeMap.Entry<K,V> |
predecessor(de.gsi.dataset.utils.trees.IndexedTreeMap.Entry<K,V> t)
Returns the predecessor of the specified Entry, or null if no such.
|
V |
put(K key,
V value)
Associates the specified value with the specified key in this map.
|
void |
putAll(Map<? extends K,? extends V> map)
Copies all of the mappings from the specified map to this map.
|
V |
remove(Object key)
Removes the mapping for this key from this IndexedTreeMap if present.
|
int |
size()
Returns the number of key-value mappings in this map.
|
NavigableMap<K,V> |
subMap(K fromKey,
boolean fromInclusive,
K toKey,
boolean toInclusive) |
SortedMap<K,V> |
subMap(K fromKey,
K toKey) |
static <K,V> de.gsi.dataset.utils.trees.IndexedTreeMap.Entry<K,V> |
successor(de.gsi.dataset.utils.trees.IndexedTreeMap.Entry<K,V> t)
Returns the successor of the specified Entry, or null if no such.
|
SortedMap<K,V> |
tailMap(K fromKey) |
NavigableMap<K,V> |
tailMap(K fromKey,
boolean inclusive) |
static boolean |
valEquals(Object o1,
Object o2)
Test two values for equality.
|
Collection<V> |
values()
Returns a
Collection view of the values contained in this map. |
equals, hashCode, isEmpty, toStringfinalize, getClass, notify, notifyAll, wait, wait, waitcompute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace, replaceAllpublic IndexedTreeMap()
Comparable interface. Furthermore, all such keys must be mutually comparable:
k1.compareTo(k2) must not throw a ClassCastException for any keys k1 and k2
in the map. If the user attempts to put a key into the map that violates this constraint (for example, the user
attempts to put a string key into a map whose keys are integers), the put(Object key, Object value) call
will throw a ClassCastException.public IndexedTreeMap(Comparator<? super K> comparator)
comparator.compare(k1,
k2) must not throw a ClassCastException for any keys k1 and k2 in the map. If the
user attempts to put a key into the map that violates this constraint, the put(Object
key, Object value) call will throw a ClassCastException.comparator - the comparator that will be used to order this map. If null, the
natural ordering of the keys will be used.public IndexedTreeMap(Map<? extends K,? extends V> m)
Comparable interface.
Furthermore, all such keys must be mutually comparable: k1.compareTo(k2) must not throw a
ClassCastException for any keys k1 and k2 in the map. This method runs in n*log(n)
time.m - the map whose mappings are to be placed in this mapClassCastException - if the keys in m are not Comparable, or are not mutually comparableNullPointerException - if the specified map is nullpublic IndexedTreeMap(SortedMap<K,? extends V> m)
m - the sorted map whose mappings are to be placed in this map, and whose comparator is to be used to sort
this mapNullPointerException - if the specified map is nullpublic static <K,V> Map.Entry<K,V> exportEntry(de.gsi.dataset.utils.trees.IndexedTreeMap.Entry<K,V> e)
K - key value typeV - value value typee - entry to be searchedpublic static <K> K key(de.gsi.dataset.utils.trees.IndexedTreeMap.Entry<K,?> e)
K - key value typee - entry to be searchedNoSuchElementException - if the Entry is nullpublic static <K,V> K keyOrNull(de.gsi.dataset.utils.trees.IndexedTreeMap.Entry<K,V> e)
K - key value typeV - value value typee - entry to be searchedpublic static <K,V> de.gsi.dataset.utils.trees.IndexedTreeMap.Entry<K,V> predecessor(de.gsi.dataset.utils.trees.IndexedTreeMap.Entry<K,V> t)
K - key value typeV - value typet - entrypublic static <K,V> de.gsi.dataset.utils.trees.IndexedTreeMap.Entry<K,V> successor(de.gsi.dataset.utils.trees.IndexedTreeMap.Entry<K,V> t)
K - key value typeV - value typet - entrypublic static boolean valEquals(Object o1, Object o2)
null o1 properly.o1 - object1 to be comparedo2 - object2 to be comparedpublic Map.Entry<K,V> ceilingEntry(K key)
ceilingEntry in interface NavigableMap<K,V>ClassCastExceptionNullPointerException - if the specified key is null and this map uses natural ordering, or its comparator
does not permit null keyspublic K ceilingKey(K key)
ceilingKey in interface NavigableMap<K,V>ClassCastExceptionNullPointerException - if the specified key is null and this map uses natural ordering, or its comparator
does not permit null keyspublic void clear()
public Object clone()
IndexedTreeMap instance. (The keys and values themselves are not cloned.)clone in class AbstractMap<K,V>public Comparator<? super K> comparator()
comparator in interface SortedMap<K,V>public boolean containsKey(Object key)
true if this map contains a mapping for the specified key.containsKey in interface Map<K,V>containsKey in class AbstractMap<K,V>key - key whose presence in this map is to be testedtrue if this map contains a mapping for the specified keyClassCastException - if the specified key cannot be compared with the keys currently in the mapNullPointerException - if the specified key is null and this map uses natural ordering, or its comparator
does not permit null keyspublic boolean containsValue(Object value)
true if this map maps one or more keys to the specified value. More formally, returns
true if and only if this map contains at least one mapping to a value v such that
(value==null ? v==null : value.equals(v)). This operation will probably require time linear in the map
size for most implementations.containsValue in interface Map<K,V>containsValue in class AbstractMap<K,V>value - value whose presence in this map is to be testedtrue if a mapping to value exists; false otherwisepublic void dbg()
public void debug()
throws Exception
Exception - if weight is incorrectpublic NavigableSet<K> descendingKeySet()
descendingKeySet in interface NavigableMap<K,V>public NavigableMap<K,V> descendingMap()
descendingMap in interface NavigableMap<K,V>public Set<Map.Entry<K,V>> entrySet()
Set view of the mappings contained in this map. The set's iterator returns the entries in
ascending key order. The set is backed by the map, so changes to the map are reflected in the set, and
vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's
own remove operation, or through the setValue operation on a map entry returned by the
iterator) the results of the iteration are undefined. The set supports element removal, which removes the
corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll,
retainAll and clear operations. It does not support the add or addAll
operations.public de.gsi.dataset.utils.trees.IndexedTreeMap.Entry<K,V> exactEntry(int index)
IndexedNavigableMapexactEntry in interface IndexedNavigableMap<K,V>index - index of the keykey located at the index (@code index) offset
from the beginning of the sorted mappublic K exactKey(int index)
IndexedNavigableMapexactKey in interface IndexedNavigableMap<K,V>index - index of the keykey located at the index (@code index) offset
from the beginning of the sorted mappublic Map.Entry<K,V> firstEntry()
firstEntry in interface NavigableMap<K,V>public K firstKey()
firstKey in interface SortedMap<K,V>NoSuchElementExceptionpublic Map.Entry<K,V> floorEntry(K key)
floorEntry in interface NavigableMap<K,V>ClassCastExceptionNullPointerException - if the specified key is null and this map uses natural ordering, or its comparator
does not permit null keyspublic K floorKey(K key)
floorKey in interface NavigableMap<K,V>ClassCastExceptionNullPointerException - if the specified key is null and this map uses natural ordering, or its comparator
does not permit null keyspublic V get(Object key)
null if this map contains no mapping for the
key.
More formally, if this map contains a mapping from a key k to a value v such that key
compares equal to k according to the map's ordering, then this method returns v; otherwise it
returns null. (There can be at most one such mapping.)
A return value of null does not necessarily indicate that the map contains no mapping for the key;
it's also possible that the map explicitly maps the key to null. The containsKey
operation may be used to distinguish these two cases.get in interface Map<K,V>get in class AbstractMap<K,V>ClassCastException - if the specified key cannot be compared with the keys currently in the mapNullPointerException - if the specified key is null and this map uses natural ordering, or its comparator
does not permit null keyspublic SortedMap<K,V> headMap(K toKey)
headMap in interface NavigableMap<K,V>headMap in interface SortedMap<K,V>ClassCastExceptionNullPointerException - if toKey is null and this map uses natural ordering, or its comparator does
not permit null keysIllegalArgumentExceptionpublic NavigableMap<K,V> headMap(K toKey, boolean inclusive)
headMap in interface NavigableMap<K,V>ClassCastExceptionNullPointerException - if toKey is null and this map uses natural ordering, or its comparator does
not permit null keysIllegalArgumentExceptionpublic Map.Entry<K,V> higherEntry(K key)
higherEntry in interface NavigableMap<K,V>ClassCastExceptionNullPointerException - if the specified key is null and this map uses natural ordering, or its comparator
does not permit null keyspublic K higherKey(K key)
higherKey in interface NavigableMap<K,V>ClassCastExceptionNullPointerException - if the specified key is null and this map uses natural ordering, or its comparator
does not permit null keyspublic int keyIndex(K key)
IndexedNavigableMapkeyIndex in interface IndexedNavigableMap<K,V>key - the keypublic Set<K> keySet()
Set view of the keys contained in this map. The set's iterator returns the keys in
ascending order. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If
the map is modified while an iteration over the set is in progress (except through the iterator's own
remove operation), the results of the iteration are undefined. The set supports element removal, which
removes the corresponding mapping from the map, via the Iterator.remove, Set.remove,
removeAll, retainAll, and clear operations. It does not support the add or
addAll operations.public Map.Entry<K,V> lastEntry()
lastEntry in interface NavigableMap<K,V>public K lastKey()
lastKey in interface SortedMap<K,V>NoSuchElementExceptionpublic Map.Entry<K,V> lowerEntry(K key)
lowerEntry in interface NavigableMap<K,V>ClassCastExceptionNullPointerException - if the specified key is null and this map uses natural ordering, or its comparator
does not permit null keyspublic K lowerKey(K key)
lowerKey in interface NavigableMap<K,V>ClassCastExceptionNullPointerException - if the specified key is null and this map uses natural ordering, or its comparator
does not permit null keyspublic NavigableSet<K> navigableKeySet()
navigableKeySet in interface NavigableMap<K,V>public Map.Entry<K,V> pollFirstEntry()
pollFirstEntry in interface NavigableMap<K,V>public Map.Entry<K,V> pollLastEntry()
pollLastEntry in interface NavigableMap<K,V>public V put(K key, V value)
put in interface Map<K,V>put in class AbstractMap<K,V>key - key with which the specified value is to be associatedvalue - value to be associated with the specified keykey, or null if there was no mapping for
key. (A null return can also indicate that the map previously associated null
with key.)ClassCastException - if the specified key cannot be compared with the keys currently in the mapNullPointerException - if the specified key is null and this map uses natural ordering, or its comparator
does not permit null keyspublic void putAll(Map<? extends K,? extends V> map)
putAll in interface Map<K,V>putAll in class AbstractMap<K,V>map - mappings to be stored in this mapClassCastException - if the class of a key or value in the specified map prevents it from being stored in
this mapNullPointerException - if the specified map is null or the specified map contains a null key and this map
does not permit null keyspublic V remove(Object key)
remove in interface Map<K,V>remove in class AbstractMap<K,V>key - key for which mapping should be removedkey, or null if there was no mapping for
key. (A null return can also indicate that the map previously associated null
with key.)ClassCastException - if the specified key cannot be compared with the keys currently in the mapNullPointerException - if the specified key is null and this map uses natural ordering, or its comparator
does not permit null keyspublic int size()
public NavigableMap<K,V> subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)
subMap in interface NavigableMap<K,V>ClassCastExceptionNullPointerException - if fromKey or toKey is null and this map uses natural ordering, or
its comparator does not permit null keysIllegalArgumentExceptionpublic SortedMap<K,V> subMap(K fromKey, K toKey)
subMap in interface NavigableMap<K,V>subMap in interface SortedMap<K,V>ClassCastExceptionNullPointerException - if fromKey or toKey is null and this map uses natural ordering, or
its comparator does not permit null keysIllegalArgumentExceptionpublic SortedMap<K,V> tailMap(K fromKey)
tailMap in interface NavigableMap<K,V>tailMap in interface SortedMap<K,V>ClassCastExceptionNullPointerException - if fromKey is null and this map uses natural ordering, or its comparator
does not permit null keysIllegalArgumentExceptionpublic NavigableMap<K,V> tailMap(K fromKey, boolean inclusive)
tailMap in interface NavigableMap<K,V>ClassCastExceptionNullPointerException - if fromKey is null and this map uses natural ordering, or its comparator
does not permit null keysIllegalArgumentExceptionpublic Collection<V> values()
Collection view of the values contained in this map. The collection's iterator returns the
values in ascending order of the corresponding keys. The collection is backed by the map, so changes to the map
are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is
in progress (except through the iterator's own remove operation), the results of the iteration are
undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the
Iterator.remove, Collection.remove, removeAll, retainAll and clear
operations. It does not support the add or addAll operations.Copyright © 2019 GSI Helmholtzzentrum für Schwerionenforschung GmbH. All rights reserved.