IndexedTreeMap (dataset 8.1.3 API)

java.lang.Object
- de.gsi.dataset.utils.trees.AbstractMap<K,V>
- - de.gsi.dataset.utils.trees.IndexedTreeMap<K,V>

Type Parameters:

K - the type of keys maintained by this map

V - the type of mapped values

All Implemented Interfaces:

IndexedNavigableMap<K,V>, Serializable, Cloneable, Map<K,V>, NavigableMap<K,V>, SortedMap<K,V>
```
public 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.
Since:

1.2

Version:

1.73, 05/10/06

Author:

Josh Bloch, Doug Lea, Vitaly Sazanovich

See Also:

Map, HashMap, Hashtable, Comparable, Comparator, Collection, Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`IndexedTreeMap.AscendingSubMap<K,V>`
`protected static class`	`IndexedTreeMap.Entry<K,V>` Node in the Tree.
`protected class`	`IndexedTreeMap.EntryIterator`
`protected class`	`IndexedTreeMap.PrivateEntryIterator<T>` Base class for IndexedTreeMap Iterators
`protected class`	`IndexedTreeMap.ValueIterator`

Nested classes/interfaces inherited from class de.gsi.dataset.utils.trees.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors
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.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAllForTreeSet(SortedSet<? extends K> set, V defaultVal)` Intended to be called only from IndexedTreeSet.addAll
`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()`
`int`	`compare(Object k1, Object k2)` Compares two keys using the correct comparison method for this IndexedTreeMap.
`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
`Iterator<K>`	`descendingKeyIterator()`
`NavigableSet<K>`	`descendingKeySet()`
`NavigableMap<K,V>`	`descendingMap()`
`Set<Map.Entry<K,V>>`	`entrySet()` Returns a `Set` view of the mappings contained in this map.
`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(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.
`IndexedTreeMap.Entry<K,V>`	`getCeilingEntry(K key)` Gets the entry corresponding to the specified key; if no such entry exists, returns the entry for the least key greater than the specified key; if no such entry exists (i.e., the greatest key in the Tree is less than the specified key), returns `null`.
`IndexedTreeMap.Entry<K,V>`	`getEntry(K key)` Returns this map's entry for the given key, or `null` if the map does not contain an entry for the key.
`IndexedTreeMap.Entry<K,V>`	`getEntryUsingComparator(K key)` Version of getEntry using comparator.
`IndexedTreeMap.Entry<K,V>`	`getFirstEntry()` Returns the first Entry in the IndexedTreeMap (according to the IndexedTreeMap's key-sort function).
`IndexedTreeMap.Entry<K,V>`	`getFloorEntry(K key)` Gets the entry corresponding to the specified key; if no such entry exists, returns the entry for the greatest key less than the specified key; if no such entry exists, returns `null`.
`IndexedTreeMap.Entry<K,V>`	`getHigherEntry(K key)` Gets the entry for the least key greater than the specified key; if no such entry exists, returns the entry for the least key greater than the specified key; if no such entry exists returns `null`.
`IndexedTreeMap.Entry<K,V>`	`getLastEntry()` Returns the last Entry in the IndexedTreeMap (according to the IndexedTreeMap's key-sort function).
`IndexedTreeMap.Entry<K,V>`	`getLowerEntry(K key)` Returns the entry for the greatest key less than the specified key; if no such entry exists (i.e., the least key in the Tree is greater than the specified key), returns `null`.
`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(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.
`Iterator<K>`	`keyIterator()`
`static <K,V> K`	`keyOrNull(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> IndexedTreeMap.Entry<K,V>`	`predecessor(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.
`void`	`readTreeSet(int size, ObjectInputStream s, V defaultVal)` Intended to be called only from IndexedTreeSet.readObject
`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> IndexedTreeMap.Entry<K,V>`	`successor(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.

Methods inherited from class de.gsi.dataset.utils.trees.AbstractMap
equals, hashCode, isEmpty, toString

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - IndexedTreeMap
```
public IndexedTreeMap()
```
    Constructs a new, empty tree map, using the natural ordering of its keys. All keys inserted into the map must implement the 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.
  - IndexedTreeMap
```
public IndexedTreeMap(Comparator<? super K> comparator)
```
    Constructs a new, empty tree map, ordered according to the given comparator. All keys inserted into the map must be mutually comparable by the given 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.
    
    Parameters:
    
    comparator - the comparator that will be used to order this map. If null, the natural ordering of the keys will be used.
  - IndexedTreeMap
```
public 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. All keys inserted into the new map must implement the 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.
    
    Parameters:
    
    m - the map whose mappings are to be placed in this map
    
    Throws:
    
    ClassCastException - if the keys in m are not Comparable, or are not mutually comparable
    
    NullPointerException - if the specified map is null
  - IndexedTreeMap
```
public 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. This method runs in linear time.
    
    Parameters:
    
    m - the sorted map whose mappings are to be placed in this map, and whose comparator is to be used to sort this map
    
    Throws:
    
    NullPointerException - if the specified map is null
- Method Detail
  - addAllForTreeSet
```
public void addAllForTreeSet(SortedSet<? extends K> set,
                             V defaultVal)
```
    Intended to be called only from IndexedTreeSet.addAll
    
    Parameters:
    
    set - ???
    
    defaultVal - ???
  - ceilingEntry
```
public Map.Entry<K,V> ceilingEntry(K key)
```
    Specified by:
    
    ceilingEntry in interface NavigableMap<K,V>
    
    Throws:
    
    ClassCastException
    
    NullPointerException - if the specified key is null and this map uses natural ordering, or its comparator does not permit null keys
    
    Since:
    
    1.6
  - ceilingKey
```
public K ceilingKey(K key)
```
    Specified by:
    
    ceilingKey in interface NavigableMap<K,V>
    
    Throws:
    
    ClassCastException
    
    NullPointerException - if the specified key is null and this map uses natural ordering, or its comparator does not permit null keys
    
    Since:
    
    1.6
  - clear
```
public void clear()
```
    Removes all of the mappings from this map. The map will be empty after this call returns.
    
    Specified by:
    
    clear in interface Map<K,V>
    
    Overrides:
    
    clear in class AbstractMap<K,V>
  - clone
```
public Object clone()
```
    Returns a shallow copy of this IndexedTreeMap instance. (The keys and values themselves are not cloned.)
    
    Overrides:
    
    clone in class AbstractMap<K,V>
    
    Returns:
    
    a shallow copy of this map
  - comparator
```
public Comparator<? super K> comparator()
```
    Specified by:
    
    comparator in interface SortedMap<K,V>
  - compare
```
public final int compare(Object k1,
                         Object k2)
```
    Compares two keys using the correct comparison method for this IndexedTreeMap.
    
    Parameters:
    
    k1 - object1 to be compared
    
    k2 - object2 to be compared
    
    Returns:
    
    true if equal
  - containsKey
```
public boolean containsKey(Object key)
```
    Returns true if this map contains a mapping for the specified key.
    
    Specified by:
    
    containsKey in interface Map<K,V>
    
    Overrides:
    
    containsKey in class AbstractMap<K,V>
    
    Parameters:
    
    key - key whose presence in this map is to be tested
    
    Returns:
    
    true if this map contains a mapping for the specified key
    
    Throws:
    
    ClassCastException - if the specified key cannot be compared with the keys currently in the map
    
    NullPointerException - if the specified key is null and this map uses natural ordering, or its comparator does not permit null keys
  - containsValue
```
public boolean containsValue(Object value)
```
    Returns 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.
    
    Specified by:
    
    containsValue in interface Map<K,V>
    
    Overrides:
    
    containsValue in class AbstractMap<K,V>
    
    Parameters:
    
    value - value whose presence in this map is to be tested
    
    Returns:
    
    true if a mapping to value exists; false otherwise
    
    Since:
    
    1.2
  - dbg
```
public void dbg()
```
    for debugging purposes
  - debug
```
public void debug()
           throws Exception
```
    for debugging purposes
    
    Throws:
    
    Exception - if weight is incorrect
  - descendingKeyIterator
```
public Iterator<K> descendingKeyIterator()
```
  - descendingKeySet
```
public NavigableSet<K> descendingKeySet()
```
    Specified by:
    
    descendingKeySet in interface NavigableMap<K,V>
    
    Since:
    
    1.6
  - descendingMap
```
public NavigableMap<K,V> descendingMap()
```
    Specified by:
    
    descendingMap in interface NavigableMap<K,V>
    
    Since:
    
    1.6
  - entrySet
```
public Set<Map.Entry<K,V>> entrySet()
```
    Returns a 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.
    
    Specified by:
    
    entrySet in interface Map<K,V>
    
    Specified by:
    
    entrySet in interface SortedMap<K,V>
    
    Specified by:
    
    entrySet in class AbstractMap<K,V>
  - exactEntry
```
public IndexedTreeMap.Entry<K,V> exactEntry(int index)
```
    Description copied from interface: IndexedNavigableMap
    
    Returns a key-value mapping associated with the key located at the index offset from the beginning of the sorted map
    
    Specified by:
    
    exactEntry in interface IndexedNavigableMap<K,V>
    
    Parameters:
    
    index - index of the key
    
    Returns:
    
    the entry with the key key located at the index (@code index) offset from the beginning of the sorted map
  - exactKey
```
public K exactKey(int index)
```
    Description copied from interface: IndexedNavigableMap
    
    Returns the key located at the index offset from the beginning of the sorted map
    
    Specified by:
    
    exactKey in interface IndexedNavigableMap<K,V>
    
    Parameters:
    
    index - index of the key
    
    Returns:
    
    the key key located at the index (@code index) offset from the beginning of the sorted map
  - firstEntry
```
public Map.Entry<K,V> firstEntry()
```
    Specified by:
    
    firstEntry in interface NavigableMap<K,V>
    
    Since:
    
    1.6
  - firstKey
```
public K firstKey()
```
    Specified by:
    
    firstKey in interface SortedMap<K,V>
    
    Throws:
    
    NoSuchElementException
  - floorEntry
```
public Map.Entry<K,V> floorEntry(K key)
```
    Specified by:
    
    floorEntry in interface NavigableMap<K,V>
    
    Throws:
    
    ClassCastException
    
    NullPointerException - if the specified key is null and this map uses natural ordering, or its comparator does not permit null keys
    
    Since:
    
    1.6
  - floorKey
```
public K floorKey(K key)
```
    Specified by:
    
    floorKey in interface NavigableMap<K,V>
    
    Throws:
    
    ClassCastException
    
    NullPointerException - if the specified key is null and this map uses natural ordering, or its comparator does not permit null keys
    
    Since:
    
    1.6
  - get
```
public 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. 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.
    
    Specified by:
    
    get in interface Map<K,V>
    
    Overrides:
    
    get in class AbstractMap<K,V>
    
    Throws:
    
    ClassCastException - if the specified key cannot be compared with the keys currently in the map
    
    NullPointerException - if the specified key is null and this map uses natural ordering, or its comparator does not permit null keys
  - getCeilingEntry
```
public final IndexedTreeMap.Entry<K,V> getCeilingEntry(K key)
```
    Gets the entry corresponding to the specified key; if no such entry exists, returns the entry for the least key greater than the specified key; if no such entry exists (i.e., the greatest key in the Tree is less than the specified key), returns null.
    
    Parameters:
    
    key - key value
    
    Returns:
    
    entry
  - getEntry
```
public final IndexedTreeMap.Entry<K,V> getEntry(K key)
```
    Returns this map's entry for the given key, or null if the map does not contain an entry for the key.
    
    Parameters:
    
    key - key value
    
    Returns:
    
    this map's entry for the given key, or null if the map does not contain an entry for the key
    
    Throws:
    
    ClassCastException - if the specified key cannot be compared with the keys currently in the map
    
    NullPointerException - if the specified key is null and this map uses natural ordering, or its comparator does not permit null keys
  - getEntryUsingComparator
```
public final IndexedTreeMap.Entry<K,V> getEntryUsingComparator(K key)
```
    Version of getEntry using comparator. Split off from getEntry for performance. (This is not worth doing for most methods, that are less dependent on comparator performance, but is worthwhile here.)
    
    Parameters:
    
    key - key value
    
    Returns:
    
    entry
  - getFirstEntry
```
public final IndexedTreeMap.Entry<K,V> getFirstEntry()
```
    Returns the first Entry in the IndexedTreeMap (according to the IndexedTreeMap's key-sort function). Returns null if the IndexedTreeMap is empty.
    
    Returns:
    
    entry
  - getFloorEntry
```
public final IndexedTreeMap.Entry<K,V> getFloorEntry(K key)
```
    Gets the entry corresponding to the specified key; if no such entry exists, returns the entry for the greatest key less than the specified key; if no such entry exists, returns null.
    
    Parameters:
    
    key - key value
    
    Returns:
    
    entry
  - getHigherEntry
```
public final IndexedTreeMap.Entry<K,V> getHigherEntry(K key)
```
    Gets the entry for the least key greater than the specified key; if no such entry exists, returns the entry for the least key greater than the specified key; if no such entry exists returns null.
    
    Parameters:
    
    key - key value
    
    Returns:
    
    entry
  - getLastEntry
```
public final IndexedTreeMap.Entry<K,V> getLastEntry()
```
    Returns the last Entry in the IndexedTreeMap (according to the IndexedTreeMap's key-sort function). Returns null if the IndexedTreeMap is empty.
    
    Returns:
    
    entry
  - getLowerEntry
```
public final IndexedTreeMap.Entry<K,V> getLowerEntry(K key)
```
    Returns the entry for the greatest key less than the specified key; if no such entry exists (i.e., the least key in the Tree is greater than the specified key), returns null.
    
    Parameters:
    
    key - key value
    
    Returns:
    
    entry
  - headMap
```
public SortedMap<K,V> headMap(K toKey)
```
    Specified by:
    
    headMap in interface NavigableMap<K,V>
    
    Specified by:
    
    headMap in interface SortedMap<K,V>
    
    Throws:
    
    ClassCastException
    
    NullPointerException - if toKey is null and this map uses natural ordering, or its comparator does not permit null keys
    
    IllegalArgumentException
  - headMap
```
public NavigableMap<K,V> headMap(K toKey,
                                 boolean inclusive)
```
    Specified by:
    
    headMap in interface NavigableMap<K,V>
    
    Throws:
    
    ClassCastException
    
    NullPointerException - if toKey is null and this map uses natural ordering, or its comparator does not permit null keys
    
    IllegalArgumentException
    
    Since:
    
    1.6
  - higherEntry
```
public Map.Entry<K,V> higherEntry(K key)
```
    Specified by:
    
    higherEntry in interface NavigableMap<K,V>
    
    Throws:
    
    ClassCastException
    
    NullPointerException - if the specified key is null and this map uses natural ordering, or its comparator does not permit null keys
    
    Since:
    
    1.6
  - higherKey
```
public K higherKey(K key)
```
    Specified by:
    
    higherKey in interface NavigableMap<K,V>
    
    Throws:
    
    ClassCastException
    
    NullPointerException - if the specified key is null and this map uses natural ordering, or its comparator does not permit null keys
    
    Since:
    
    1.6
  - keyIndex
```
public int keyIndex(K key)
```
    Description copied from interface: IndexedNavigableMap
    
    Searches the specified tree map for the specified key using the put algorithm. Calculates its offset from the beginning of the sorted map using weights.
    
    Specified by:
    
    keyIndex in interface IndexedNavigableMap<K,V>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    index of the search key, if it is contained in the tree map; otherwise a NullPointerException is thrown
  - keyIterator
```
public Iterator<K> keyIterator()
```
  - keySet
```
public Set<K> keySet()
```
    Returns a 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.
    
    Specified by:
    
    keySet in interface Map<K,V>
    
    Specified by:
    
    keySet in interface SortedMap<K,V>
    
    Overrides:
    
    keySet in class AbstractMap<K,V>
  - lastEntry
```
public Map.Entry<K,V> lastEntry()
```
    Specified by:
    
    lastEntry in interface NavigableMap<K,V>
    
    Since:
    
    1.6
  - lastKey
```
public K lastKey()
```
    Specified by:
    
    lastKey in interface SortedMap<K,V>
    
    Throws:
    
    NoSuchElementException
  - lowerEntry
```
public Map.Entry<K,V> lowerEntry(K key)
```
    Specified by:
    
    lowerEntry in interface NavigableMap<K,V>
    
    Throws:
    
    ClassCastException
    
    NullPointerException - if the specified key is null and this map uses natural ordering, or its comparator does not permit null keys
    
    Since:
    
    1.6
  - lowerKey
```
public K lowerKey(K key)
```
    Specified by:
    
    lowerKey in interface NavigableMap<K,V>
    
    Throws:
    
    ClassCastException
    
    NullPointerException - if the specified key is null and this map uses natural ordering, or its comparator does not permit null keys
    
    Since:
    
    1.6
  - navigableKeySet
```
public NavigableSet<K> navigableKeySet()
```
    Specified by:
    
    navigableKeySet in interface NavigableMap<K,V>
    
    Since:
    
    1.6
  - pollFirstEntry
```
public Map.Entry<K,V> pollFirstEntry()
```
    Specified by:
    
    pollFirstEntry in interface NavigableMap<K,V>
    
    Since:
    
    1.6
  - pollLastEntry
```
public Map.Entry<K,V> pollLastEntry()
```
    Specified by:
    
    pollLastEntry in interface NavigableMap<K,V>
    
    Since:
    
    1.6
  - put
```
public V put(K key,
             V value)
```
    Associates the specified value with the specified key in this map. If the map previously contained a mapping for the key, the old value is replaced.
    
    Specified by:
    
    put in interface Map<K,V>
    
    Overrides:
    
    put in class AbstractMap<K,V>
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    value - value to be associated with the specified key
    
    Returns:
    
    the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key.)
    
    Throws:
    
    ClassCastException - if the specified key cannot be compared with the keys currently in the map
    
    NullPointerException - if the specified key is null and this map uses natural ordering, or its comparator does not permit null keys
  - putAll
```
public void putAll(Map<? extends K,? extends V> map)
```
    Copies all of the mappings from the specified map to this map. These mappings replace any mappings that this map had for any of the keys currently in the specified map.
    
    Specified by:
    
    putAll in interface Map<K,V>
    
    Overrides:
    
    putAll in class AbstractMap<K,V>
    
    Parameters:
    
    map - mappings to be stored in this map
    
    Throws:
    
    ClassCastException - if the class of a key or value in the specified map prevents it from being stored in this map
    
    NullPointerException - if the specified map is null or the specified map contains a null key and this map does not permit null keys
  - readTreeSet
```
public void readTreeSet(int size,
                        ObjectInputStream s,
                        V defaultVal)
                 throws IOException,
                        ClassNotFoundException
```
    Intended to be called only from IndexedTreeSet.readObject
    
    Parameters:
    
    size - ???
    
    s - output stream
    
    defaultVal - ???
    
    Throws:
    
    IOException - in case of write errors
    
    ClassNotFoundException - in case of class casting errors
  - remove
```
public V remove(Object key)
```
    Removes the mapping for this key from this IndexedTreeMap if present.
    
    Specified by:
    
    remove in interface Map<K,V>
    
    Overrides:
    
    remove in class AbstractMap<K,V>
    
    Parameters:
    
    key - key for which mapping should be removed
    
    Returns:
    
    the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key.)
    
    Throws:
    
    ClassCastException - if the specified key cannot be compared with the keys currently in the map
    
    NullPointerException - if the specified key is null and this map uses natural ordering, or its comparator does not permit null keys
  - size
```
public int size()
```
    Returns the number of key-value mappings in this map.
    
    Specified by:
    
    size in interface Map<K,V>
    
    Overrides:
    
    size in class AbstractMap<K,V>
    
    Returns:
    
    the number of key-value mappings in this map
  - subMap
```
public NavigableMap<K,V> subMap(K fromKey,
                                boolean fromInclusive,
                                K toKey,
                                boolean toInclusive)
```
    Specified by:
    
    subMap in interface NavigableMap<K,V>
    
    Throws:
    
    ClassCastException
    
    NullPointerException - if fromKey or toKey is null and this map uses natural ordering, or its comparator does not permit null keys
    
    IllegalArgumentException
    
    Since:
    
    1.6
  - subMap
```
public SortedMap<K,V> subMap(K fromKey,
                             K toKey)
```
    Specified by:
    
    subMap in interface NavigableMap<K,V>
    
    Specified by:
    
    subMap in interface SortedMap<K,V>
    
    Throws:
    
    ClassCastException
    
    NullPointerException - if fromKey or toKey is null and this map uses natural ordering, or its comparator does not permit null keys
    
    IllegalArgumentException
  - tailMap
```
public SortedMap<K,V> tailMap(K fromKey)
```
    Specified by:
    
    tailMap in interface NavigableMap<K,V>
    
    Specified by:
    
    tailMap in interface SortedMap<K,V>
    
    Throws:
    
    ClassCastException
    
    NullPointerException - if fromKey is null and this map uses natural ordering, or its comparator does not permit null keys
    
    IllegalArgumentException
  - tailMap
```
public NavigableMap<K,V> tailMap(K fromKey,
                                 boolean inclusive)
```
    Specified by:
    
    tailMap in interface NavigableMap<K,V>
    
    Throws:
    
    ClassCastException
    
    NullPointerException - if fromKey is null and this map uses natural ordering, or its comparator does not permit null keys
    
    IllegalArgumentException
    
    Since:
    
    1.6
  - values
```
public Collection<V> values()
```
    Returns a 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.
    
    Specified by:
    
    values in interface Map<K,V>
    
    Specified by:
    
    values in interface SortedMap<K,V>
    
    Overrides:
    
    values in class AbstractMap<K,V>
  - exportEntry
```
public static <K,V> Map.Entry<K,V> exportEntry(IndexedTreeMap.Entry<K,V> e)
```
    Return SimpleImmutableEntry for entry, or null if null
    
    Type Parameters:
    
    K - key value type
    
    V - value value type
    
    Parameters:
    
    e - entry to be searched
    
    Returns:
    
    entry
  - key
```
public static <K> K key(IndexedTreeMap.Entry<K,?> e)
```
    Returns the key corresponding to the specified Entry.
    
    Type Parameters:
    
    K - key value type
    
    Parameters:
    
    e - entry to be searched
    
    Returns:
    
    key
    
    Throws:
    
    NoSuchElementException - if the Entry is null
  - keyOrNull
```
public static <K,V> K keyOrNull(IndexedTreeMap.Entry<K,V> e)
```
    Return key for entry, or null if null
    
    Type Parameters:
    
    K - key value type
    
    V - value value type
    
    Parameters:
    
    e - entry to be searched
    
    Returns:
    
    key
  - predecessor
```
public static <K,V> IndexedTreeMap.Entry<K,V> predecessor(IndexedTreeMap.Entry<K,V> t)
```
    Returns the predecessor of the specified Entry, or null if no such.
    
    Type Parameters:
    
    K - key value type
    
    V - value type
    
    Parameters:
    
    t - entry
    
    Returns:
    
    predecessor entry
  - successor
```
public static <K,V> IndexedTreeMap.Entry<K,V> successor(IndexedTreeMap.Entry<K,V> t)
```
    Returns the successor of the specified Entry, or null if no such.
    
    Type Parameters:
    
    K - key value type
    
    V - value type
    
    Parameters:
    
    t - entry
    
    Returns:
    
    successor entry
  - valEquals
```
public static boolean valEquals(Object o1,
                                Object o2)
```
    Test two values for equality. Differs from o1.equals(o2) only in that it copes with null o1 properly.
    
    Parameters:
    
    o1 - object1 to be compared
    
    o2 - object2 to be compared
    
    Returns:
    
    true if equal

Class IndexedTreeMap<K,V>

Nested Class Summary

Nested classes/interfaces inherited from class de.gsi.dataset.utils.trees.AbstractMap

Constructor Summary

Method Summary

Methods inherited from class de.gsi.dataset.utils.trees.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

IndexedTreeMap

IndexedTreeMap

IndexedTreeMap

IndexedTreeMap

Method Detail

addAllForTreeSet

ceilingEntry

ceilingKey

clear

clone

comparator

compare

containsKey

containsValue

dbg

debug

descendingKeyIterator

descendingKeySet

descendingMap

entrySet

exactEntry

exactKey

firstEntry

firstKey

floorEntry

floorKey

get

getCeilingEntry

getEntry

getEntryUsingComparator

getFirstEntry

getFloorEntry

getHigherEntry

getLastEntry

getLowerEntry

headMap

headMap

higherEntry

higherKey

keyIndex

keyIterator

keySet

lastEntry

lastKey

lowerEntry

lowerKey

navigableKeySet

pollFirstEntry

pollLastEntry

put

putAll

readTreeSet

remove

size

subMap

subMap

tailMap

tailMap

values

exportEntry

key

keyOrNull

predecessor

successor

valEquals