Long2ObjectRBTreeMap (Primitive-Collections 0.2.0 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Long,V>
- - speiger.src.collections.longs.maps.abstracts.AbstractLong2ObjectMap<V>
  - - speiger.src.collections.longs.maps.impl.tree.Long2ObjectRBTreeMap<V>

Type Parameters:

V - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.LongFunction<V>, java.util.Map<java.lang.Long,V>, java.util.NavigableMap<java.lang.Long,V>, java.util.SortedMap<java.lang.Long,V>, Long2ObjectFunction<V>, Long2ObjectMap<V>, Long2ObjectNavigableMap<V>, Long2ObjectSortedMap<V>
```
public class Long2ObjectRBTreeMap<V>
extends AbstractLong2ObjectMap<V>
implements Long2ObjectNavigableMap<V>
```
A Simple Type Specific RB TreeMap implementation that reduces boxing/unboxing. It is using a bit more memory then FastUtil, but it saves a lot of Performance on the Optimized removal and iteration logic. Which makes the implementation actually useable and does not get outperformed by Javas default implementation.

Nested Class Summary
- Nested classes/interfaces inherited from class speiger.src.collections.longs.maps.abstracts.AbstractLong2ObjectMap
  AbstractLong2ObjectMap.BasicEntry<V>
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface speiger.src.collections.longs.maps.interfaces.Long2ObjectSortedMap
  Long2ObjectSortedMap.FastSortedSet<V>
- Nested classes/interfaces inherited from interface speiger.src.collections.longs.maps.interfaces.Long2ObjectMap
  Long2ObjectMap.FastEntrySet<V>

Constructor Summary

Constructors
Constructor and Description
`Long2ObjectRBTreeMap()` Default Constructor
`Long2ObjectRBTreeMap(long[] keys, V[] values)` Helper constructor that allow to create a map from unboxed values
`Long2ObjectRBTreeMap(java.lang.Long[] keys, V[] values)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`Long2ObjectRBTreeMap(long[] keys, V[] values, LongComparator comp)` Helper constructor that has a custom sorter and allow to create a map from unboxed values
`Long2ObjectRBTreeMap(java.lang.Long[] keys, V[] values, LongComparator comp)` Helper constructor that has a custom sorter and allow to create a map from boxed values (it will unbox them)
`Long2ObjectRBTreeMap(Long2ObjectMap<V> map)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`Long2ObjectRBTreeMap(Long2ObjectMap<V> map, LongComparator comp)` A Type Specific Helper function that has a custom sorter and allows to create a new Map with exactly the same values as the provided map.
`Long2ObjectRBTreeMap(LongComparator comp)` Constructor that allows to define the sorter
`Long2ObjectRBTreeMap(java.util.Map<? extends java.lang.Long,? extends V> map)` A Helper constructor that allows to create a Map with exactly the same values as the provided map.
`Long2ObjectRBTreeMap(java.util.Map<? extends java.lang.Long,? extends V> map, LongComparator comp)` A Helper constructor that has a custom sorter and allows to create a Map with exactly the same values as the provided map.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Long2ObjectMap.Entry<V>`	`ceilingEntry(long key)` A Type Specific ceilingEntry method to reduce boxing/unboxing.
`long`	`ceilingKey(long e)` A Type Specific ceilingKey method to reduce boxing/unboxing.
`void`	`clear()`
`LongComparator`	`comparator()`
`V`	`compute(long key, LongObjectUnaryOperator<V> mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`V`	`computeIfAbsent(long key, Long2ObjectFunction<V> mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`V`	`computeIfPresent(long key, LongObjectUnaryOperator<V> mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`boolean`	`containsKey(long key)` Type Specific method to reduce boxing/unboxing of values
`LongNavigableSet`	`descendingKeySet()`
`Long2ObjectNavigableMap<V>`	`descendingMap()`
`Long2ObjectMap.Entry<V>`	`firstEntry()`
`long`	`firstLongKey()` A method to get the first Key of a Map.
`V`	`firstValue()` A method to get the first Value of a Map.
`Long2ObjectMap.Entry<V>`	`floorEntry(long key)` A Type Specific floorEntry method to reduce boxing/unboxing.
`long`	`floorKey(long e)` A Type Specific floorKey method to reduce boxing/unboxing.
`V`	`getAndMoveToFirst(long key)` A Specific get method that allows to move teh given key/value int the first index.
`V`	`getAndMoveToLast(long key)` A Specific get method that allows to move teh given key/value int the last index.
`long`	`getDefaultMaxValue()` A Helper method to get the max value for SubMaps.
`long`	`getDefaultMinValue()` A Helper method to get the min value for SubMaps.
`V`	`getObject(long key)` A Type Specific get method to reduce boxing/unboxing
`V`	`getOrDefault(long key, V defaultValue)` A Type Specific getOrDefault method to reduce boxing/unboxing
`Long2ObjectNavigableMap<V>`	`headMap(long toKey, boolean inclusive)` A Type Specific HeadMap method to reduce boxing/unboxing
`Long2ObjectMap.Entry<V>`	`higherEntry(long key)` A Type Specific higherEntry method to reduce boxing/unboxing.
`long`	`higherKey(long e)` A Type Specific higherKey method to reduce boxing/unboxing.
`LongSortedSet`	`keySet()`
`Long2ObjectMap.Entry<V>`	`lastEntry()`
`long`	`lastLongKey()` A method to get the last Key of a Map.
`V`	`lastValue()` A method to get the last Value of a Map.
`ObjectSet<Long2ObjectMap.Entry<V>>`	`long2ObjectEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`Long2ObjectMap.Entry<V>`	`lowerEntry(long key)` A Type Specific lowerEntry method to reduce boxing/unboxing.
`long`	`lowerKey(long e)` A Type Specific lowerKey method to reduce boxing/unboxing.
`V`	`merge(long key, V value, ObjectObjectUnaryOperator<V,V> mappingFunction)` A Type Specific merge method to reduce boxing/unboxing
`void`	`mergeAll(Long2ObjectMap<V> m, ObjectObjectUnaryOperator<V,V> mappingFunction)` A Bulk method for merging Maps.
`boolean`	`moveToFirst(long key)` A specific move method to move a given key/value to the first index.
`boolean`	`moveToLast(long key)` A specific move method to move a given key/value to the last index.
`LongNavigableSet`	`navigableKeySet()`
`Long2ObjectMap.Entry<V>`	`pollFirstEntry()`
`long`	`pollFirstLongKey()` A method to get and remove the first Key of a Map.
`Long2ObjectMap.Entry<V>`	`pollLastEntry()`
`long`	`pollLastLongKey()` A method to get and remove the last Key of a Map.
`V`	`put(long key, V value)` Type Specific method to reduce boxing/unboxing of values
`V`	`putAndMoveToFirst(long key, V value)` A customized put method that allows you to insert into the first index.
`V`	`putAndMoveToLast(long key, V value)` A customized put method that allows you to insert into the last index.
`V`	`putIfAbsent(long key, V value)` Type Specific method to reduce boxing/unboxing of values
`V`	`remLong(long key)` Type Specific remove function to reduce boxing/unboxing
`V`	`remLongOrDefault(long key, V defaultValue)` Type-Specific Remove function with a default return value if wanted.
`boolean`	`remove(long key, V value)` Type Specific remove function to reduce boxing/unboxing
`V`	`replace(long key, V value)` A Type Specific replace method to reduce boxing/unboxing replace an existing value
`boolean`	`replace(long key, V oldValue, V newValue)` A Type Specific replace method to replace an existing value
`void`	`setDefaultMaxValue(long value)` A Helper method to set the max value for SubMaps.
`void`	`setDefaultMinValue(long value)` A Helper method to set the min value for SubMaps.
`int`	`size()`
`Long2ObjectNavigableMap<V>`	`subMap(long fromKey, boolean fromInclusive, long toKey, boolean toInclusive)` A Type Specific SubMap method to reduce boxing/unboxing
`Long2ObjectNavigableMap<V>`	`tailMap(long fromKey, boolean inclusive)` A Type Specific TailMap method to reduce boxing/unboxing
`ObjectCollection<V>`	`values()`

Methods inherited from class speiger.src.collections.longs.maps.abstracts.AbstractLong2ObjectMap
containsValue, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, putAll, putAll, putAll, putAllIfAbsent, replaceObjects, replaceObjects, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap
containsKey, isEmpty, put, remove, toString

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

Methods inherited from interface speiger.src.collections.longs.maps.interfaces.Long2ObjectNavigableMap
ceilingEntry, ceilingKey, floorEntry, floorKey, headMap, headMap, headMap, higherEntry, higherKey, lowerEntry, lowerKey, subMap, subMap, subMap, tailMap, tailMap, tailMap

Methods inherited from interface speiger.src.collections.longs.maps.interfaces.Long2ObjectSortedMap
firstKey, lastKey

Methods inherited from interface speiger.src.collections.longs.maps.interfaces.Long2ObjectMap
compute, computeIfAbsent, computeIfPresent, containsKey, entrySet, forEach, forEach, get, getDefaultReturnValue, getOrDefault, merge, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, remove, remove, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue

Methods inherited from interface speiger.src.collections.longs.functions.function.Long2ObjectFunction
apply

Methods inherited from interface java.util.SortedMap
entrySet

Methods inherited from interface java.util.Map
containsValue, equals, hashCode, isEmpty, putAll

- Constructor Detail
  - Long2ObjectRBTreeMap
```
public Long2ObjectRBTreeMap()
```
    Default Constructor
  - Long2ObjectRBTreeMap
```
public Long2ObjectRBTreeMap(LongComparator comp)
```
    Constructor that allows to define the sorter
    
    Parameters:
    
    comp - the function that decides how the tree is sorted, can be null
  - Long2ObjectRBTreeMap
```
public Long2ObjectRBTreeMap(java.lang.Long[] keys,
                            V[] values)
```
    Helper constructor that allow to create a map from boxed values (it will unbox them)
    
    Parameters:
    
    keys - the keys that should be put into the map
    
    values - the values that should be put into the map.
    
    Throws:
    
    java.lang.IllegalStateException - if the keys and values do not match in lenght
  - Long2ObjectRBTreeMap
```
public Long2ObjectRBTreeMap(java.lang.Long[] keys,
                            V[] values,
                            LongComparator comp)
```
    Helper constructor that has a custom sorter and allow to create a map from boxed values (it will unbox them)
    
    Parameters:
    
    keys - the keys that should be put into the map
    
    values - the values that should be put into the map.
    
    comp - the function that decides how the tree is sorted, can be null
    
    Throws:
    
    java.lang.IllegalStateException - if the keys and values do not match in lenght
  - Long2ObjectRBTreeMap
```
public Long2ObjectRBTreeMap(long[] keys,
                            V[] values)
```
    Helper constructor that allow to create a map from unboxed values
    
    Parameters:
    
    keys - the keys that should be put into the map
    
    values - the values that should be put into the map.
    
    Throws:
    
    java.lang.IllegalStateException - if the keys and values do not match in lenght
  - Long2ObjectRBTreeMap
```
public Long2ObjectRBTreeMap(long[] keys,
                            V[] values,
                            LongComparator comp)
```
    Helper constructor that has a custom sorter and allow to create a map from unboxed values
    
    Parameters:
    
    keys - the keys that should be put into the map
    
    values - the values that should be put into the map.
    
    comp - the function that decides how the tree is sorted, can be null
    
    Throws:
    
    java.lang.IllegalStateException - if the keys and values do not match in lenght
  - Long2ObjectRBTreeMap
```
public Long2ObjectRBTreeMap(java.util.Map<? extends java.lang.Long,? extends V> map)
```
    A Helper constructor that allows to create a Map with exactly the same values as the provided map.
    
    Parameters:
    
    map - the values that should be present in the map
  - Long2ObjectRBTreeMap
```
public Long2ObjectRBTreeMap(java.util.Map<? extends java.lang.Long,? extends V> map,
                            LongComparator comp)
```
    A Helper constructor that has a custom sorter and allows to create a Map with exactly the same values as the provided map.
    
    Parameters:
    
    map - the values that should be present in the map
    
    comp - the function that decides how the tree is sorted, can be null
  - Long2ObjectRBTreeMap
```
public Long2ObjectRBTreeMap(Long2ObjectMap<V> map)
```
    A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
    
    Parameters:
    
    map - the values that should be present in the map
  - Long2ObjectRBTreeMap
```
public Long2ObjectRBTreeMap(Long2ObjectMap<V> map,
                            LongComparator comp)
```
    A Type Specific Helper function that has a custom sorter and allows to create a new Map with exactly the same values as the provided map.
    
    Parameters:
    
    map - the values that should be present in the map
    
    comp - the function that decides how the tree is sorted, can be null
- Method Detail
  - setDefaultMaxValue
```
public void setDefaultMaxValue(long value)
```
    Description copied from interface: Long2ObjectNavigableMap
    
    A Helper method to set the max value for SubMaps. (Default: long.MIN_VALUE)
    
    Specified by:
    
    setDefaultMaxValue in interface Long2ObjectNavigableMap<V>
    
    Parameters:
    
    value - the new max value
  - getDefaultMaxValue
```
public long getDefaultMaxValue()
```
    Description copied from interface: Long2ObjectNavigableMap
    
    A Helper method to get the max value for SubMaps.
    
    Specified by:
    
    getDefaultMaxValue in interface Long2ObjectNavigableMap<V>
    
    Returns:
    
    the default max value.
  - setDefaultMinValue
```
public void setDefaultMinValue(long value)
```
    Description copied from interface: Long2ObjectNavigableMap
    
    A Helper method to set the min value for SubMaps. (Default: long.MAX_VALUE)
    
    Specified by:
    
    setDefaultMinValue in interface Long2ObjectNavigableMap<V>
    
    Parameters:
    
    value - the new min value
  - getDefaultMinValue
```
public long getDefaultMinValue()
```
    Description copied from interface: Long2ObjectNavigableMap
    
    A Helper method to get the min value for SubMaps.
    
    Specified by:
    
    getDefaultMinValue in interface Long2ObjectNavigableMap<V>
    
    Returns:
    
    the default min value.
  - put
```
public V put(long key,
             V value)
```
    Description copied from interface: Long2ObjectMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    put in interface Long2ObjectMap<V>
    
    Parameters:
    
    key - the key that should be inserted,
    
    value - the value that should be inserted
    
    Returns:
    
    the last present value or default return value.
    
    See Also:
    
    Map.put(Object, Object)
  - putIfAbsent
```
public V putIfAbsent(long key,
                     V value)
```
    Description copied from interface: Long2ObjectMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    putIfAbsent in interface Long2ObjectMap<V>
    
    Parameters:
    
    key - the key that should be inserted,
    
    value - the value that should be inserted
    
    Returns:
    
    the last present value or default return value.
    
    See Also:
    
    Map.putIfAbsent(Object, Object)
  - putAndMoveToFirst
```
public V putAndMoveToFirst(long key,
                           V value)
```
    Description copied from interface: Long2ObjectSortedMap
    
    A customized put method that allows you to insert into the first index.
    
    Specified by:
    
    putAndMoveToFirst in interface Long2ObjectSortedMap<V>
    
    Parameters:
    
    key - the key that should be inserted
    
    value - the value that should be inserted
    
    Returns:
    
    the previous present or default return value
    
    See Also:
    
    Map.put(Object, Object)
  - putAndMoveToLast
```
public V putAndMoveToLast(long key,
                          V value)
```
    Description copied from interface: Long2ObjectSortedMap
    
    A customized put method that allows you to insert into the last index. (This may be nessesary depending on the implementation)
    
    Specified by:
    
    putAndMoveToLast in interface Long2ObjectSortedMap<V>
    
    Parameters:
    
    key - the key that should be inserted
    
    value - the value that should be inserted
    
    Returns:
    
    the previous present or default return value
    
    See Also:
    
    Map.put(Object, Object)
  - moveToFirst
```
public boolean moveToFirst(long key)
```
    Description copied from interface: Long2ObjectSortedMap
    
    A specific move method to move a given key/value to the first index.
    
    Specified by:
    
    moveToFirst in interface Long2ObjectSortedMap<V>
    
    Parameters:
    
    key - that should be moved to the first index
    
    Returns:
    
    true if the value was moved.
  - moveToLast
```
public boolean moveToLast(long key)
```
    Description copied from interface: Long2ObjectSortedMap
    
    A specific move method to move a given key/value to the last index.
    
    Specified by:
    
    moveToLast in interface Long2ObjectSortedMap<V>
    
    Parameters:
    
    key - that should be moved to the first last
    
    Returns:
    
    true if the value was moved.
  - getAndMoveToFirst
```
public V getAndMoveToFirst(long key)
```
    Description copied from interface: Long2ObjectSortedMap
    
    A Specific get method that allows to move teh given key/value int the first index.
    
    Specified by:
    
    getAndMoveToFirst in interface Long2ObjectSortedMap<V>
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - getAndMoveToLast
```
public V getAndMoveToLast(long key)
```
    Description copied from interface: Long2ObjectSortedMap
    
    A Specific get method that allows to move teh given key/value int the last index.
    
    Specified by:
    
    getAndMoveToLast in interface Long2ObjectSortedMap<V>
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - comparator
```
public LongComparator comparator()
```
    Specified by:
    
    comparator in interface java.util.SortedMap<java.lang.Long,V>
    
    Specified by:
    
    comparator in interface Long2ObjectSortedMap<V>
  - containsKey
```
public boolean containsKey(long key)
```
    Description copied from interface: Long2ObjectMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    containsKey in interface Long2ObjectMap<V>
    
    Overrides:
    
    containsKey in class AbstractLong2ObjectMap<V>
    
    Parameters:
    
    key - element that is searched for
    
    Returns:
    
    if the key is present
  - getObject
```
public V getObject(long key)
```
    Description copied from interface: Long2ObjectMap
    
    A Type Specific get method to reduce boxing/unboxing
    
    Specified by:
    
    getObject in interface Long2ObjectFunction<V>
    
    Specified by:
    
    getObject in interface Long2ObjectMap<V>
    
    Parameters:
    
    key - the key that is searched for
    
    Returns:
    
    the searched value or default return value
  - getOrDefault
```
public V getOrDefault(long key,
                      V defaultValue)
```
    Description copied from interface: Long2ObjectMap
    
    A Type Specific getOrDefault method to reduce boxing/unboxing
    
    Specified by:
    
    getOrDefault in interface Long2ObjectMap<V>
    
    Overrides:
    
    getOrDefault in class AbstractLong2ObjectMap<V>
    
    Parameters:
    
    key - the key that is searched for
    
    defaultValue - the value that should be returned if the key is not present
    
    Returns:
    
    the searched value or defaultValue value
  - firstLongKey
```
public long firstLongKey()
```
    Description copied from interface: Long2ObjectSortedMap
    
    A method to get the first Key of a Map.
    
    Specified by:
    
    firstLongKey in interface Long2ObjectSortedMap<V>
    
    Returns:
    
    the first key in the map
  - pollFirstLongKey
```
public long pollFirstLongKey()
```
    Description copied from interface: Long2ObjectSortedMap
    
    A method to get and remove the first Key of a Map.
    
    Specified by:
    
    pollFirstLongKey in interface Long2ObjectSortedMap<V>
    
    Returns:
    
    the first key in the map
  - lastLongKey
```
public long lastLongKey()
```
    Description copied from interface: Long2ObjectSortedMap
    
    A method to get the last Key of a Map.
    
    Specified by:
    
    lastLongKey in interface Long2ObjectSortedMap<V>
    
    Returns:
    
    the last key in the map
  - pollLastLongKey
```
public long pollLastLongKey()
```
    Description copied from interface: Long2ObjectSortedMap
    
    A method to get and remove the last Key of a Map.
    
    Specified by:
    
    pollLastLongKey in interface Long2ObjectSortedMap<V>
    
    Returns:
    
    the last key in the map
  - firstEntry
```
public Long2ObjectMap.Entry<V> firstEntry()
```
    Specified by:
    
    firstEntry in interface java.util.NavigableMap<java.lang.Long,V>
    
    Specified by:
    
    firstEntry in interface Long2ObjectNavigableMap<V>
    
    Returns:
    
    a Type Specific firstEntry
  - lastEntry
```
public Long2ObjectMap.Entry<V> lastEntry()
```
    Specified by:
    
    lastEntry in interface java.util.NavigableMap<java.lang.Long,V>
    
    Specified by:
    
    lastEntry in interface Long2ObjectNavigableMap<V>
    
    Returns:
    
    a Type Specific lastEntry
  - pollFirstEntry
```
public Long2ObjectMap.Entry<V> pollFirstEntry()
```
    Specified by:
    
    pollFirstEntry in interface java.util.NavigableMap<java.lang.Long,V>
    
    Specified by:
    
    pollFirstEntry in interface Long2ObjectNavigableMap<V>
    
    Returns:
    
    a Type Specific pollFirstEntry
  - pollLastEntry
```
public Long2ObjectMap.Entry<V> pollLastEntry()
```
    Specified by:
    
    pollLastEntry in interface java.util.NavigableMap<java.lang.Long,V>
    
    Specified by:
    
    pollLastEntry in interface Long2ObjectNavigableMap<V>
    
    Returns:
    
    a Type Specific pollLastEntry
  - firstValue
```
public V firstValue()
```
    Description copied from interface: Long2ObjectSortedMap
    
    A method to get the first Value of a Map.
    
    Specified by:
    
    firstValue in interface Long2ObjectSortedMap<V>
    
    Returns:
    
    the first key in the map
  - lastValue
```
public V lastValue()
```
    Description copied from interface: Long2ObjectSortedMap
    
    A method to get the last Value of a Map.
    
    Specified by:
    
    lastValue in interface Long2ObjectSortedMap<V>
    
    Returns:
    
    the last key in the map
  - remLong
```
public V remLong(long key)
```
    Description copied from interface: Long2ObjectMap
    
    Type Specific remove function to reduce boxing/unboxing
    
    Specified by:
    
    remLong in interface Long2ObjectMap<V>
    
    Parameters:
    
    key - the element that should be removed
    
    Returns:
    
    the value that was removed or default return value
  - remLongOrDefault
```
public V remLongOrDefault(long key,
                          V defaultValue)
```
    Description copied from interface: Long2ObjectMap
    
    Type-Specific Remove function with a default return value if wanted.
    
    Specified by:
    
    remLongOrDefault in interface Long2ObjectMap<V>
    
    Parameters:
    
    key - the element that should be removed
    
    defaultValue - the value that should be returned if the entry doesn't exist
    
    Returns:
    
    the value that was removed or default value
    
    See Also:
    
    Map.remove(Object, Object)
  - remove
```
public boolean remove(long key,
                      V value)
```
    Description copied from interface: Long2ObjectMap
    
    Type Specific remove function to reduce boxing/unboxing
    
    Specified by:
    
    remove in interface Long2ObjectMap<V>
    
    Parameters:
    
    key - the element that should be removed
    
    value - the expected value that should be found
    
    Returns:
    
    true if the key and value was found and removed
    
    See Also:
    
    Map.remove(Object, Object)
  - replace
```
public boolean replace(long key,
                       V oldValue,
                       V newValue)
```
    Description copied from interface: Long2ObjectMap
    
    A Type Specific replace method to replace an existing value
    
    Specified by:
    
    replace in interface Long2ObjectMap<V>
    
    Overrides:
    
    replace in class AbstractLong2ObjectMap<V>
    
    Parameters:
    
    key - the element that should be searched for
    
    oldValue - the expected value to be replaced
    
    newValue - the value to replace the oldValue with.
    
    Returns:
    
    true if the value got replaced
  - replace
```
public V replace(long key,
                 V value)
```
    Description copied from interface: Long2ObjectMap
    
    A Type Specific replace method to reduce boxing/unboxing replace an existing value
    
    Specified by:
    
    replace in interface Long2ObjectMap<V>
    
    Overrides:
    
    replace in class AbstractLong2ObjectMap<V>
    
    Parameters:
    
    key - the element that should be searched for
    
    value - the value to replace with.
    
    Returns:
    
    the present value or default return value
  - compute
```
public V compute(long key,
                 LongObjectUnaryOperator<V> mappingFunction)
```
    Description copied from interface: Long2ObjectMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    compute in interface Long2ObjectMap<V>
    
    Overrides:
    
    compute in class AbstractLong2ObjectMap<V>
    
    Parameters:
    
    key - the key that should be computed
    
    mappingFunction - the operator that should generate the value
    
    Returns:
    
    the result of the computation
  - computeIfAbsent
```
public V computeIfAbsent(long key,
                         Long2ObjectFunction<V> mappingFunction)
```
    Description copied from interface: Long2ObjectMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeIfAbsent in interface Long2ObjectMap<V>
    
    Overrides:
    
    computeIfAbsent in class AbstractLong2ObjectMap<V>
    
    Parameters:
    
    key - the key that should be computed
    
    mappingFunction - the operator that should generate the value if not present
    
    Returns:
    
    the result of the computed value or present value
  - computeIfPresent
```
public V computeIfPresent(long key,
                          LongObjectUnaryOperator<V> mappingFunction)
```
    Description copied from interface: Long2ObjectMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeIfPresent in interface Long2ObjectMap<V>
    
    Overrides:
    
    computeIfPresent in class AbstractLong2ObjectMap<V>
    
    Parameters:
    
    key - the key that should be computed
    
    mappingFunction - the operator that should generate the value if present
    
    Returns:
    
    the result of the default return value or present value
  - merge
```
public V merge(long key,
               V value,
               ObjectObjectUnaryOperator<V,V> mappingFunction)
```
    Description copied from interface: Long2ObjectMap
    
    A Type Specific merge method to reduce boxing/unboxing
    
    Specified by:
    
    merge in interface Long2ObjectMap<V>
    
    Overrides:
    
    merge in class AbstractLong2ObjectMap<V>
    
    Parameters:
    
    key - the key that should be be searched for
    
    value - the value that should be merged with
    
    mappingFunction - the operator that should generate the new Value
    
    Returns:
    
    the result of the merge
  - mergeAll
```
public void mergeAll(Long2ObjectMap<V> m,
                     ObjectObjectUnaryOperator<V,V> mappingFunction)
```
    Description copied from interface: Long2ObjectMap
    
    A Bulk method for merging Maps.
    
    Specified by:
    
    mergeAll in interface Long2ObjectMap<V>
    
    Overrides:
    
    mergeAll in class AbstractLong2ObjectMap<V>
    
    Parameters:
    
    m - the entries that should be bulk added
    
    mappingFunction - the operator that should generate the new Value
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Map<java.lang.Long,V>
    
    Overrides:
    
    size in class java.util.AbstractMap<java.lang.Long,V>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<java.lang.Long,V>
    
    Overrides:
    
    clear in class java.util.AbstractMap<java.lang.Long,V>
  - keySet
```
public LongSortedSet keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Long,V>
    
    Specified by:
    
    keySet in interface java.util.SortedMap<java.lang.Long,V>
    
    Specified by:
    
    keySet in interface Long2ObjectMap<V>
    
    Specified by:
    
    keySet in interface Long2ObjectSortedMap<V>
    
    Overrides:
    
    keySet in class AbstractLong2ObjectMap<V>
  - long2ObjectEntrySet
```
public ObjectSet<Long2ObjectMap.Entry<V>> long2ObjectEntrySet()
```
    Description copied from interface: Long2ObjectMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Specified by:
    
    long2ObjectEntrySet in interface Long2ObjectMap<V>
    
    Returns:
    
    a EntrySet of the collection
  - values
```
public ObjectCollection<V> values()
```
    Specified by:
    
    values in interface java.util.Map<java.lang.Long,V>
    
    Specified by:
    
    values in interface java.util.SortedMap<java.lang.Long,V>
    
    Specified by:
    
    values in interface Long2ObjectMap<V>
    
    Specified by:
    
    values in interface Long2ObjectSortedMap<V>
    
    Overrides:
    
    values in class AbstractLong2ObjectMap<V>
  - navigableKeySet
```
public LongNavigableSet navigableKeySet()
```
    Specified by:
    
    navigableKeySet in interface java.util.NavigableMap<java.lang.Long,V>
    
    Specified by:
    
    navigableKeySet in interface Long2ObjectNavigableMap<V>
    
    Returns:
    
    a Type Specific Navigable Key Set
  - descendingMap
```
public Long2ObjectNavigableMap<V> descendingMap()
```
    Specified by:
    
    descendingMap in interface java.util.NavigableMap<java.lang.Long,V>
    
    Specified by:
    
    descendingMap in interface Long2ObjectNavigableMap<V>
    
    Returns:
    
    a Type Specific desendingMap
  - descendingKeySet
```
public LongNavigableSet descendingKeySet()
```
    Specified by:
    
    descendingKeySet in interface java.util.NavigableMap<java.lang.Long,V>
    
    Specified by:
    
    descendingKeySet in interface Long2ObjectNavigableMap<V>
    
    Returns:
    
    a Type Specific Desending Key Set
  - subMap
```
public Long2ObjectNavigableMap<V> subMap(long fromKey,
                                         boolean fromInclusive,
                                         long toKey,
                                         boolean toInclusive)
```
    Description copied from interface: Long2ObjectNavigableMap
    
    A Type Specific SubMap method to reduce boxing/unboxing
    
    Specified by:
    
    subMap in interface Long2ObjectNavigableMap<V>
    
    Parameters:
    
    fromKey - where the submap should start
    
    fromInclusive - if the fromKey is inclusive or not
    
    toKey - where the subMap should end
    
    toInclusive - if the toKey is inclusive or not
    
    Returns:
    
    a SubMap that is within the range of the desired range
  - headMap
```
public Long2ObjectNavigableMap<V> headMap(long toKey,
                                          boolean inclusive)
```
    Description copied from interface: Long2ObjectNavigableMap
    
    A Type Specific HeadMap method to reduce boxing/unboxing
    
    Specified by:
    
    headMap in interface Long2ObjectNavigableMap<V>
    
    Parameters:
    
    toKey - where the HeadMap should end
    
    inclusive - if the toKey is inclusive or not
    
    Returns:
    
    a HeadMap that is within the range of the desired range
  - tailMap
```
public Long2ObjectNavigableMap<V> tailMap(long fromKey,
                                          boolean inclusive)
```
    Description copied from interface: Long2ObjectNavigableMap
    
    A Type Specific TailMap method to reduce boxing/unboxing
    
    Specified by:
    
    tailMap in interface Long2ObjectNavigableMap<V>
    
    Parameters:
    
    fromKey - where the TailMap should start
    
    inclusive - if the fromKey is inclusive or not
    
    Returns:
    
    a TailMap that is within the range of the desired range
  - lowerKey
```
public long lowerKey(long e)
```
    Description copied from interface: Long2ObjectNavigableMap
    
    A Type Specific lowerKey method to reduce boxing/unboxing.
    
    Specified by:
    
    lowerKey in interface Long2ObjectNavigableMap<V>
    
    Parameters:
    
    e - that should be compared with.
    
    Returns:
    
    the greatest lower key that can be found
  - floorKey
```
public long floorKey(long e)
```
    Description copied from interface: Long2ObjectNavigableMap
    
    A Type Specific floorKey method to reduce boxing/unboxing.
    
    Specified by:
    
    floorKey in interface Long2ObjectNavigableMap<V>
    
    Parameters:
    
    e - that should be compared with.
    
    Returns:
    
    the greatest lower or equal key that can be found
  - higherKey
```
public long higherKey(long e)
```
    Description copied from interface: Long2ObjectNavigableMap
    
    A Type Specific higherKey method to reduce boxing/unboxing.
    
    Specified by:
    
    higherKey in interface Long2ObjectNavigableMap<V>
    
    Parameters:
    
    e - that should be compared with.
    
    Returns:
    
    the lowest higher key that can be found
  - ceilingKey
```
public long ceilingKey(long e)
```
    Description copied from interface: Long2ObjectNavigableMap
    
    A Type Specific ceilingKey method to reduce boxing/unboxing.
    
    Specified by:
    
    ceilingKey in interface Long2ObjectNavigableMap<V>
    
    Parameters:
    
    e - that should be compared with.
    
    Returns:
    
    the lowest higher or equal key that can be found
  - lowerEntry
```
public Long2ObjectMap.Entry<V> lowerEntry(long key)
```
    Description copied from interface: Long2ObjectNavigableMap
    
    A Type Specific lowerEntry method to reduce boxing/unboxing.
    
    Specified by:
    
    lowerEntry in interface Long2ObjectNavigableMap<V>
    
    Parameters:
    
    key - that should be compared with.
    
    Returns:
    
    the greatest lower entry that can be found, or null
  - higherEntry
```
public Long2ObjectMap.Entry<V> higherEntry(long key)
```
    Description copied from interface: Long2ObjectNavigableMap
    
    A Type Specific higherEntry method to reduce boxing/unboxing.
    
    Specified by:
    
    higherEntry in interface Long2ObjectNavigableMap<V>
    
    Parameters:
    
    key - that should be compared with.
    
    Returns:
    
    the lowest higher entry that can be found, or null
  - floorEntry
```
public Long2ObjectMap.Entry<V> floorEntry(long key)
```
    Description copied from interface: Long2ObjectNavigableMap
    
    A Type Specific floorEntry method to reduce boxing/unboxing.
    
    Specified by:
    
    floorEntry in interface Long2ObjectNavigableMap<V>
    
    Parameters:
    
    key - that should be compared with.
    
    Returns:
    
    the greatest lower or equal entry that can be found, or null
  - ceilingEntry
```
public Long2ObjectMap.Entry<V> ceilingEntry(long key)
```
    Description copied from interface: Long2ObjectNavigableMap
    
    A Type Specific ceilingEntry method to reduce boxing/unboxing.
    
    Specified by:
    
    ceilingEntry in interface Long2ObjectNavigableMap<V>
    
    Parameters:
    
    key - that should be compared with.
    
    Returns:
    
    the lowest higher or equal entry that can be found, or null

Class Long2ObjectRBTreeMap<V>

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.longs.maps.abstracts.AbstractLong2ObjectMap

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface speiger.src.collections.longs.maps.interfaces.Long2ObjectSortedMap

Nested classes/interfaces inherited from interface speiger.src.collections.longs.maps.interfaces.Long2ObjectMap

Constructor Summary

Method Summary

Methods inherited from class speiger.src.collections.longs.maps.abstracts.AbstractLong2ObjectMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.longs.maps.interfaces.Long2ObjectNavigableMap

Methods inherited from interface speiger.src.collections.longs.maps.interfaces.Long2ObjectSortedMap

Methods inherited from interface speiger.src.collections.longs.maps.interfaces.Long2ObjectMap

Methods inherited from interface speiger.src.collections.longs.functions.function.Long2ObjectFunction

Methods inherited from interface java.util.SortedMap

Methods inherited from interface java.util.Map

Constructor Detail

Long2ObjectRBTreeMap

Long2ObjectRBTreeMap

Long2ObjectRBTreeMap

Long2ObjectRBTreeMap

Long2ObjectRBTreeMap

Long2ObjectRBTreeMap

Long2ObjectRBTreeMap

Long2ObjectRBTreeMap

Long2ObjectRBTreeMap

Long2ObjectRBTreeMap

Method Detail

setDefaultMaxValue

getDefaultMaxValue

setDefaultMinValue

getDefaultMinValue

put

putIfAbsent

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

comparator

containsKey

getObject

getOrDefault

firstLongKey

pollFirstLongKey

lastLongKey

pollLastLongKey

firstEntry

lastEntry

pollFirstEntry

pollLastEntry

firstValue

lastValue

remLong

remLongOrDefault

remove

replace

replace

compute

computeIfAbsent

computeIfPresent

merge

mergeAll

size

clear

keySet

long2ObjectEntrySet

values

navigableKeySet

descendingMap

descendingKeySet

subMap

headMap

tailMap

lowerKey

floorKey

higherKey

ceilingKey