ImmutableTreeMap (Open Traffic Sim demo classes 0.12.00 API)

java.lang.Object
- org.opentrafficsim.base.immutablecollections.ImmutableAbstractMap<K,V>
- - org.opentrafficsim.base.immutablecollections.ImmutableTreeMap<K,V>

Type Parameters:

K - the key type of content of this Map

V - the value type of content of this Map

All Implemented Interfaces:

Serializable, ImmutableMap<K,V>, ImmutableNavigableMap<K,V>, ImmutableSortedMap<K,V>
```
public class ImmutableTreeMap<K,V>
extends ImmutableAbstractMap<K,V>
implements ImmutableNavigableMap<K,V>
```
An immutable wrapper for a TreeMap.
Copyright (c) 2013-2016 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.
$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version May 7, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`ImmutableTreeMap(ImmutableTreeMap<K,V> immutableMap)`
`ImmutableTreeMap(ImmutableTreeMap<K,V> immutableTreeMap, Immutable copyOrWrap)`
`ImmutableTreeMap(SortedMap<K,V> sortedMap)`
`ImmutableTreeMap(SortedMap<K,V> map, Immutable copyOrWrap)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`K`	`ceilingKey(K key)` Returns the least key in this immutable map greater than or equal to the given key, or `null` if there is no such key.
`Comparator<? super K>`	`comparator()` Returns the comparator used to order the keys in this immutable map, or `null` if this immutable map uses the natural ordering of its keys.
`ImmutableNavigableMap<K,V>`	`descendingMap()` Returns a reverse order view of the keys contained in this immutable map.
`K`	`firstKey()` Returns the first (lowest) key currently in this immutable map.
`K`	`floorKey(K key)` Returns the greatest key in this immutable map less than or equal to the given key, or `null` if there is no such key.
`protected NavigableMap<K,V>`	`getMap()` Prepare the map of the right type for use a subclass.
`ImmutableSortedMap<K,V>`	`headMap(K toKey)` Returns a view of the portion of this immutable map whose keys are strictly less than `toKey`.
`ImmutableNavigableMap<K,V>`	`headMap(K toKey, boolean inclusive)` Returns a view of the portion of this immutable map whose keys are less than (or equal to, if `inclusive` is true) `toKey`.
`K`	`higherKey(K key)` Returns the least key in this immutable map strictly greater than the given key, or `null` if there is no such key.
`ImmutableSortedSet<K>`	`keySet()` Returns a `ImmutableSortedSet` view of the keys contained in this map.
`K`	`lastKey()` Returns the last (highest) key currently in this immutable map.
`K`	`lowerKey(K key)` Returns the greatest key in this immutable map strictly less than the given key, or `null` if there is no such key.
`ImmutableNavigableMap<K,V>`	`subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)` Returns a view of the portion of this immutable map whose keys range from `fromKey` to `toKey`.
`ImmutableSortedMap<K,V>`	`subMap(K fromKey, K toKey)` Returns a view of the portion of this immutable map whose keys range from `fromKey`, inclusive, to `toKey`, exclusive.
`ImmutableSortedMap<K,V>`	`tailMap(K fromKey)` Returns a view of the portion of this immutable map whose keys are greater than or equal to `fromKey`.
`ImmutableNavigableMap<K,V>`	`tailMap(K fromKey, boolean inclusive)` Returns a view of the portion of this immutable map whose keys are greater than (or equal to, if `inclusive` is true) `fromKey`.
`NavigableMap<K,V>`	`toMap()` Returns a modifiable copy of this immutable map.
`String`	`toString()`

Methods inherited from class org.opentrafficsim.base.immutablecollections.ImmutableAbstractMap
containsKey, containsValue, equals, get, hashCode, isEmpty, isWrap, size, values

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

Methods inherited from interface org.opentrafficsim.base.immutablecollections.ImmutableNavigableMap
equals, hashCode

Methods inherited from interface org.opentrafficsim.base.immutablecollections.ImmutableMap
containsKey, containsValue, forEach, get, getOrDefault, isCopy, isEmpty, isWrap, size, values

- Constructor Detail
  - ImmutableTreeMap
```
public ImmutableTreeMap(SortedMap<K,V> sortedMap)
```
    Parameters:
    
    sortedMap - the map to use as the immutable map.
  - ImmutableTreeMap
```
public ImmutableTreeMap(SortedMap<K,V> map,
                        Immutable copyOrWrap)
```
    Parameters:
    
    map - the map to use as the immutable map.
    
    copyOrWrap - COPY stores a safe, internal copy of the collection; WRAP stores a pointer to the original collection
  - ImmutableTreeMap
```
public ImmutableTreeMap(ImmutableTreeMap<K,V> immutableMap)
```
    Parameters:
    
    immutableMap - the map to use as the immutable map.
  - ImmutableTreeMap
```
public ImmutableTreeMap(ImmutableTreeMap<K,V> immutableTreeMap,
                        Immutable copyOrWrap)
```
    Parameters:
    
    immutableTreeMap - the map to use as the immutable map.
    
    copyOrWrap - COPY stores a safe, internal copy of the collection; WRAP stores a pointer to the original collection
- Method Detail
  - getMap
```
protected final NavigableMap<K,V> getMap()
```
    Prepare the map of the right type for use a subclass. Implement e.g. as follows:
```
  @Override
 protected HashMap<E> getMap()
 {
     return (HashMap<E>) super.getMap();
 }
 
```
    Overrides:
    
    getMap in class ImmutableAbstractMap<K,V>
    
    Returns:
    
    the map of the right type for use a subclass
  - toMap
```
public final NavigableMap<K,V> toMap()
```
    Returns a modifiable copy of this immutable map.
    
    Specified by:
    
    toMap in interface ImmutableMap<K,V>
    
    Specified by:
    
    toMap in interface ImmutableNavigableMap<K,V>
    
    Specified by:
    
    toMap in interface ImmutableSortedMap<K,V>
    
    Returns:
    
    a modifiable copy of this immutable map.
  - keySet
```
public final ImmutableSortedSet<K> keySet()
```
    Returns a ImmutableSortedSet view of the keys contained in this map.
    
    Specified by:
    
    keySet in interface ImmutableMap<K,V>
    
    Specified by:
    
    keySet in interface ImmutableNavigableMap<K,V>
    
    Specified by:
    
    keySet in interface ImmutableSortedMap<K,V>
    
    Returns:
    
    an immutable sorted set of the keys contained in this map
  - comparator
```
public final Comparator<? super K> comparator()
```
    Returns the comparator used to order the keys in this immutable map, or null if this immutable map uses the natural ordering of its keys.
    
    Specified by:
    
    comparator in interface ImmutableSortedMap<K,V>
    
    Returns:
    
    the comparator used to order the keys in this immutable map, or null if this immutable map uses the natural ordering of its keys
  - subMap
```
public final ImmutableSortedMap<K,V> subMap(K fromKey,
                                            K toKey)
```
    Returns a view of the portion of this immutable map whose keys range from fromKey, inclusive, to toKey, exclusive. (If fromKey and toKey are equal, the returned immutable map is empty.)
    The result of this method is a new, immutable sorted map.
    
    Specified by:
    
    subMap in interface ImmutableSortedMap<K,V>
    
    Parameters:
    
    fromKey - low endpoint (inclusive) of the returned immutable map
    
    toKey - high endpoint (exclusive) of the returned immutable map
    
    Returns:
    
    a new, immutable sorted map of the portion of this immutable map whose keys range from fromKey, inclusive, to toKey, exclusive
  - headMap
```
public final ImmutableSortedMap<K,V> headMap(K toKey)
```
    Returns a view of the portion of this immutable map whose keys are strictly less than toKey. The returned immutable map is backed by this immutable map, so changes in the returned immutable map are reflected in this immutable map, and vice-versa. The returned immutable map supports all optional immutable map operations that this immutable map supports.
    The result of this method is a new, immutable sorted map.
    
    Specified by:
    
    headMap in interface ImmutableSortedMap<K,V>
    
    Parameters:
    
    toKey - high endpoint (exclusive) of the returned immutable map
    
    Returns:
    
    a view of the portion of this immutable map whose keys are strictly less than toKey
  - tailMap
```
public final ImmutableSortedMap<K,V> tailMap(K fromKey)
```
    Returns a view of the portion of this immutable map whose keys are greater than or equal to fromKey. The returned immutable map is backed by this immutable map, so changes in the returned immutable map are reflected in this immutable map, and vice-versa. The returned immutable map supports all optional immutable map operations that this immutable map supports.
    The result of this method is a new, immutable sorted map.
    
    Specified by:
    
    tailMap in interface ImmutableSortedMap<K,V>
    
    Parameters:
    
    fromKey - low endpoint (inclusive) of the returned immutable map
    
    Returns:
    
    a view of the portion of this immutable map whose keys are greater than or equal to fromKey
  - firstKey
```
public final K firstKey()
```
    Returns the first (lowest) key currently in this immutable map.
    
    Specified by:
    
    firstKey in interface ImmutableSortedMap<K,V>
    
    Returns:
    
    the first (lowest) key currently in this immutable map
  - lastKey
```
public final K lastKey()
```
    Returns the last (highest) key currently in this immutable map.
    
    Specified by:
    
    lastKey in interface ImmutableSortedMap<K,V>
    
    Returns:
    
    the last (highest) key currently in this immutable map
  - lowerKey
```
public final K lowerKey(K key)
```
    Returns the greatest key in this immutable map strictly less than the given key, or null if there is no such key.
    
    Specified by:
    
    lowerKey in interface ImmutableNavigableMap<K,V>
    
    Parameters:
    
    key - the value to match
    
    Returns:
    
    the greatest key less than e, or null if there is no such key
  - floorKey
```
public final K floorKey(K key)
```
    Returns the greatest key in this immutable map less than or equal to the given key, or null if there is no such key.
    
    Specified by:
    
    floorKey in interface ImmutableNavigableMap<K,V>
    
    Parameters:
    
    key - the value to match
    
    Returns:
    
    the greatest key less than or equal to e, or null if there is no such key
  - ceilingKey
```
public final K ceilingKey(K key)
```
    Returns the least key in this immutable map greater than or equal to the given key, or null if there is no such key.
    
    Specified by:
    
    ceilingKey in interface ImmutableNavigableMap<K,V>
    
    Parameters:
    
    key - the value to match
    
    Returns:
    
    the least key greater than or equal to e, or null if there is no such key
  - higherKey
```
public final K higherKey(K key)
```
    Returns the least key in this immutable map strictly greater than the given key, or null if there is no such key.
    
    Specified by:
    
    higherKey in interface ImmutableNavigableMap<K,V>
    
    Parameters:
    
    key - the value to match
    
    Returns:
    
    the least key greater than e, or null if there is no such key
  - descendingMap
```
public final ImmutableNavigableMap<K,V> descendingMap()
```
    Returns a reverse order view of the keys contained in this immutable map.
    The returned immutable map has an ordering equivalent to Collections.reverseOrder(comparator()). The expression s.descendingMap().descendingMap() returns a view of s essentially equivalent to s.
    
    Specified by:
    
    descendingMap in interface ImmutableNavigableMap<K,V>
    
    Returns:
    
    a reverse order view of this immutable map
  - subMap
```
public final ImmutableNavigableMap<K,V> subMap(K fromKey,
                                               boolean fromInclusive,
                                               K toKey,
                                               boolean toInclusive)
```
    Returns a view of the portion of this immutable map whose keys range from fromKey to toKey. If fromKey and toKey are equal, the returned immutable map is empty unless fromInclusive and toInclusive are both true.
    
    Specified by:
    
    subMap in interface ImmutableNavigableMap<K,V>
    
    Parameters:
    
    fromKey - low endpoint of the returned immutable map
    
    fromInclusive - true if the low endpoint is to be included in the returned view
    
    toKey - high endpoint of the returned immutable map
    
    toInclusive - true if the high endpoint is to be included in the returned view
    
    Returns:
    
    a view of the portion of this immutable map whose keys range from fromKey, inclusive, to toKey, exclusive
  - headMap
```
public final ImmutableNavigableMap<K,V> headMap(K toKey,
                                                boolean inclusive)
```
    Returns a view of the portion of this immutable map whose keys are less than (or equal to, if inclusive is true) toKey.
    
    Specified by:
    
    headMap in interface ImmutableNavigableMap<K,V>
    
    Parameters:
    
    toKey - high endpoint of the returned immutable map
    
    inclusive - true if the high endpoint is to be included in the returned view
    
    Returns:
    
    a view of the portion of this immutable map whose keys are less than (or equal to, if inclusive is true) toKey
  - tailMap
```
public final ImmutableNavigableMap<K,V> tailMap(K fromKey,
                                                boolean inclusive)
```
    Returns a view of the portion of this immutable map whose keys are greater than (or equal to, if inclusive is true) fromKey.
    
    Specified by:
    
    tailMap in interface ImmutableNavigableMap<K,V>
    
    Parameters:
    
    fromKey - low endpoint of the returned immutable map
    
    inclusive - true if the low endpoint is to be included in the returned view
    
    Returns:
    
    a view of the portion of this immutable map whose keys are greater than or equal to fromKey
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class ImmutableAbstractMap<K,V>

Class ImmutableTreeMap<K,V>

Constructor Summary

Method Summary

Methods inherited from class org.opentrafficsim.base.immutablecollections.ImmutableAbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface org.opentrafficsim.base.immutablecollections.ImmutableNavigableMap

Methods inherited from interface org.opentrafficsim.base.immutablecollections.ImmutableMap

Constructor Detail

ImmutableTreeMap

ImmutableTreeMap

ImmutableTreeMap

ImmutableTreeMap

Method Detail

getMap

toMap

keySet

comparator

subMap

headMap

tailMap

firstKey

lastKey

lowerKey

floorKey

ceilingKey

higherKey

descendingMap

subMap

headMap

tailMap

toString