Char2ShortRBTreeMap (Primitive-Collections 0.7.0 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Character,java.lang.Short>
- - speiger.src.collections.chars.maps.abstracts.AbstractChar2ShortMap
  - - speiger.src.collections.chars.maps.impl.tree.Char2ShortRBTreeMap

All Implemented Interfaces:

java.util.Map<java.lang.Character,java.lang.Short>, java.util.NavigableMap<java.lang.Character,java.lang.Short>, java.util.SortedMap<java.lang.Character,java.lang.Short>, Char2ShortFunction, Char2ShortMap, Char2ShortNavigableMap, Char2ShortSortedMap
```
public class Char2ShortRBTreeMap
extends AbstractChar2ShortMap
implements Char2ShortNavigableMap
```
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.chars.maps.abstracts.AbstractChar2ShortMap
  AbstractChar2ShortMap.BasicEntry
- 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.chars.maps.interfaces.Char2ShortSortedMap
  Char2ShortSortedMap.FastSortedSet
- Nested classes/interfaces inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ShortMap
  Char2ShortMap.BuilderCache, Char2ShortMap.Entry, Char2ShortMap.FastEntrySet, Char2ShortMap.MapBuilder

Constructor Summary

Constructors
Constructor and Description
`Char2ShortRBTreeMap()` Default Constructor
`Char2ShortRBTreeMap(char[] keys, short[] values)` Helper constructor that allow to create a map from unboxed values
`Char2ShortRBTreeMap(char[] keys, short[] values, CharComparator comp)` Helper constructor that has a custom sorter and allow to create a map from unboxed values
`Char2ShortRBTreeMap(Char2ShortMap map)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`Char2ShortRBTreeMap(Char2ShortMap map, CharComparator 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.
`Char2ShortRBTreeMap(java.lang.Character[] keys, java.lang.Short[] values)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`Char2ShortRBTreeMap(java.lang.Character[] keys, java.lang.Short[] values, CharComparator comp)` Helper constructor that has a custom sorter and allow to create a map from boxed values (it will unbox them)
`Char2ShortRBTreeMap(CharComparator comp)` Constructor that allows to define the sorter
`Char2ShortRBTreeMap(java.util.Map<? extends java.lang.Character,? extends java.lang.Short> map)` A Helper constructor that allows to create a Map with exactly the same values as the provided map.
`Char2ShortRBTreeMap(java.util.Map<? extends java.lang.Character,? extends java.lang.Short> map, CharComparator 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
`short`	`addTo(char key, short value)` A Helper method to add a primitives together.
`Char2ShortMap.Entry`	`ceilingEntry(char key)` A Type Specific ceilingEntry method to reduce boxing/unboxing.
`char`	`ceilingKey(char e)` A Type Specific ceilingKey method to reduce boxing/unboxing.
`ObjectSet<Char2ShortMap.Entry>`	`char2ShortEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`void`	`clear()`
`CharComparator`	`comparator()`
`short`	`computeShort(char key, CharShortUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`short`	`computeShortIfAbsent(char key, Char2ShortFunction mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`short`	`computeShortIfPresent(char key, CharShortUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`boolean`	`containsKey(char key)` Type Specific method to reduce boxing/unboxing of values
`Char2ShortRBTreeMap`	`copy()` A Function that does a shallow clone of the Map itself.
`CharNavigableSet`	`descendingKeySet()`
`Char2ShortNavigableMap`	`descendingMap()`
`char`	`firstCharKey()` A method to get the first Key of a Map.
`Char2ShortMap.Entry`	`firstEntry()`
`short`	`firstShortValue()` A method to get the first Value of a Map.
`Char2ShortMap.Entry`	`floorEntry(char key)` A Type Specific floorEntry method to reduce boxing/unboxing.
`char`	`floorKey(char e)` A Type Specific floorKey method to reduce boxing/unboxing.
`void`	`forEach(CharShortConsumer action)` Type Specific forEach method to reduce boxing/unboxing
`short`	`get(char key)` A Type Specific get method to reduce boxing/unboxing
`char`	`getDefaultMaxValue()` A Helper method to get the max value for SubMaps.
`char`	`getDefaultMinValue()` A Helper method to get the min value for SubMaps.
`short`	`getOrDefault(char key, short defaultValue)` A Type Specific getOrDefault method to reduce boxing/unboxing
`Char2ShortNavigableMap`	`headMap(char toKey, boolean inclusive)` A Type Specific HeadMap method to reduce boxing/unboxing
`Char2ShortMap.Entry`	`higherEntry(char key)` A Type Specific higherEntry method to reduce boxing/unboxing.
`char`	`higherKey(char e)` A Type Specific higherKey method to reduce boxing/unboxing.
`CharNavigableSet`	`keySet()`
`char`	`lastCharKey()` A method to get the last Key of a Map.
`Char2ShortMap.Entry`	`lastEntry()`
`short`	`lastShortValue()` A method to get the last Value of a Map.
`Char2ShortMap.Entry`	`lowerEntry(char key)` A Type Specific lowerEntry method to reduce boxing/unboxing.
`char`	`lowerKey(char e)` A Type Specific lowerKey method to reduce boxing/unboxing.
`void`	`mergeAllShort(Char2ShortMap m, ShortShortUnaryOperator mappingFunction)` A Bulk method for merging Maps.
`short`	`mergeShort(char key, short value, ShortShortUnaryOperator mappingFunction)` A Type Specific merge method to reduce boxing/unboxing
`CharNavigableSet`	`navigableKeySet()`
`char`	`pollFirstCharKey()` A method to get and remove the first Key of a Map.
`Char2ShortMap.Entry`	`pollFirstEntry()`
`char`	`pollLastCharKey()` A method to get and remove the last Key of a Map.
`Char2ShortMap.Entry`	`pollLastEntry()`
`short`	`put(char key, short value)` Type Specific method to reduce boxing/unboxing of values
`short`	`putIfAbsent(char key, short value)` Type Specific method to reduce boxing/unboxing of values
`short`	`remove(char key)` Type Specific remove function to reduce boxing/unboxing
`boolean`	`remove(char key, short value)` Type Specific remove function to reduce boxing/unboxing
`short`	`removeOrDefault(char key, short defaultValue)` Type-Specific Remove function with a default return value if wanted.
`short`	`replace(char key, short value)` A Type Specific replace method to reduce boxing/unboxing replace an existing value
`boolean`	`replace(char key, short oldValue, short newValue)` A Type Specific replace method to replace an existing value
`void`	`setDefaultMaxValue(char value)` A Helper method to set the max value for SubMaps.
`void`	`setDefaultMinValue(char value)` A Helper method to set the min value for SubMaps.
`int`	`size()`
`short`	`subFrom(char key, short value)` A Helper method to subtract from primitive from each other.
`Char2ShortNavigableMap`	`subMap(char fromKey, boolean fromInclusive, char toKey, boolean toInclusive)` A Type Specific SubMap method to reduce boxing/unboxing
`short`	`supplyShortIfAbsent(char key, ShortSupplier valueProvider)` A Supplier based computeIfAbsent function to fill the most used usecase of this function
`Char2ShortNavigableMap`	`tailMap(char fromKey, boolean inclusive)` A Type Specific TailMap method to reduce boxing/unboxing
`ShortCollection`	`values()`

Methods inherited from class speiger.src.collections.chars.maps.abstracts.AbstractChar2ShortMap
addToAll, containsValue, entrySet, equals, get, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, remove, replaceShorts, replaceShorts, setDefaultReturnValue

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

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

Methods inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ShortNavigableMap
ceilingEntry, ceilingKey, floorEntry, floorKey, headMap, headMap, headMap, higherEntry, higherKey, lowerEntry, lowerKey, subMap, subMap, subMap, synchronize, synchronize, tailMap, tailMap, tailMap, unmodifiable

Methods inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ShortSortedMap
firstKey, lastKey

Methods inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ShortMap
addToAll, builder, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, containsValue, entrySet, forEach, get, getDefaultReturnValue, getOrDefault, merge, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, remove, remove, replace, replace, replaceAll, replaceShorts, replaceShorts, setDefaultReturnValue

Methods inherited from interface java.util.SortedMap
entrySet

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

- Constructor Detail
  - Char2ShortRBTreeMap
```
public Char2ShortRBTreeMap()
```
    Default Constructor
  - Char2ShortRBTreeMap
```
public Char2ShortRBTreeMap(CharComparator comp)
```
    Constructor that allows to define the sorter
    
    Parameters:
    
    comp - the function that decides how the tree is sorted, can be null
  - Char2ShortRBTreeMap
```
public Char2ShortRBTreeMap(java.lang.Character[] keys,
                           java.lang.Short[] 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
  - Char2ShortRBTreeMap
```
public Char2ShortRBTreeMap(java.lang.Character[] keys,
                           java.lang.Short[] values,
                           CharComparator 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
  - Char2ShortRBTreeMap
```
public Char2ShortRBTreeMap(char[] keys,
                           short[] 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
  - Char2ShortRBTreeMap
```
public Char2ShortRBTreeMap(char[] keys,
                           short[] values,
                           CharComparator 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
  - Char2ShortRBTreeMap
```
public Char2ShortRBTreeMap(java.util.Map<? extends java.lang.Character,? extends java.lang.Short> 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
  - Char2ShortRBTreeMap
```
public Char2ShortRBTreeMap(java.util.Map<? extends java.lang.Character,? extends java.lang.Short> map,
                           CharComparator 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
  - Char2ShortRBTreeMap
```
public Char2ShortRBTreeMap(Char2ShortMap 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
  - Char2ShortRBTreeMap
```
public Char2ShortRBTreeMap(Char2ShortMap map,
                           CharComparator 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(char value)
```
    Description copied from interface: Char2ShortNavigableMap
    
    A Helper method to set the max value for SubMaps. (Default: char.MIN_VALUE)
    
    Specified by:
    
    setDefaultMaxValue in interface Char2ShortNavigableMap
    
    Parameters:
    
    value - the new max value
  - getDefaultMaxValue
```
public char getDefaultMaxValue()
```
    Description copied from interface: Char2ShortNavigableMap
    
    A Helper method to get the max value for SubMaps.
    
    Specified by:
    
    getDefaultMaxValue in interface Char2ShortNavigableMap
    
    Returns:
    
    the default max value.
  - setDefaultMinValue
```
public void setDefaultMinValue(char value)
```
    Description copied from interface: Char2ShortNavigableMap
    
    A Helper method to set the min value for SubMaps. (Default: char.MAX_VALUE)
    
    Specified by:
    
    setDefaultMinValue in interface Char2ShortNavigableMap
    
    Parameters:
    
    value - the new min value
  - getDefaultMinValue
```
public char getDefaultMinValue()
```
    Description copied from interface: Char2ShortNavigableMap
    
    A Helper method to get the min value for SubMaps.
    
    Specified by:
    
    getDefaultMinValue in interface Char2ShortNavigableMap
    
    Returns:
    
    the default min value.
  - put
```
public short put(char key,
                 short value)
```
    Description copied from interface: Char2ShortMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    put in interface Char2ShortMap
    
    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 short putIfAbsent(char key,
                         short value)
```
    Description copied from interface: Char2ShortMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    putIfAbsent in interface Char2ShortMap
    
    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)
  - addTo
```
public short addTo(char key,
                   short value)
```
    Description copied from interface: Char2ShortMap
    
    A Helper method to add a primitives together. If key is not present then this functions as a put.
    
    Specified by:
    
    addTo in interface Char2ShortMap
    
    Parameters:
    
    key - the key that should be inserted,
    
    value - the value that should be inserted / added
    
    Returns:
    
    the last present value or default return value.
  - subFrom
```
public short subFrom(char key,
                     short value)
```
    Description copied from interface: Char2ShortMap
    
    A Helper method to subtract from primitive from each other. If the key is not present it will just return the defaultValue How the implementation works is that it will subtract from the current value (if not present it will do nothing) and fence it to the Char2ShortMap.getDefaultReturnValue() If the fence is reached the element will be automaticall removed
    
    Specified by:
    
    subFrom in interface Char2ShortMap
    
    Parameters:
    
    key - that should be subtract from
    
    value - that should be subtract
    
    Returns:
    
    the last present or default return value
  - comparator
```
public CharComparator comparator()
```
    Specified by:
    
    comparator in interface java.util.SortedMap<java.lang.Character,java.lang.Short>
    
    Specified by:
    
    comparator in interface Char2ShortSortedMap
  - containsKey
```
public boolean containsKey(char key)
```
    Description copied from interface: Char2ShortMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    containsKey in interface Char2ShortMap
    
    Overrides:
    
    containsKey in class AbstractChar2ShortMap
    
    Parameters:
    
    key - element that is searched for
    
    Returns:
    
    if the key is present
  - get
```
public short get(char key)
```
    Description copied from interface: Char2ShortMap
    
    A Type Specific get method to reduce boxing/unboxing
    
    Specified by:
    
    get in interface Char2ShortFunction
    
    Specified by:
    
    get in interface Char2ShortMap
    
    Parameters:
    
    key - the key that is searched for
    
    Returns:
    
    the searched value or default return value
  - getOrDefault
```
public short getOrDefault(char key,
                          short defaultValue)
```
    Description copied from interface: Char2ShortMap
    
    A Type Specific getOrDefault method to reduce boxing/unboxing
    
    Specified by:
    
    getOrDefault in interface Char2ShortMap
    
    Overrides:
    
    getOrDefault in class AbstractChar2ShortMap
    
    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
  - firstCharKey
```
public char firstCharKey()
```
    Description copied from interface: Char2ShortSortedMap
    
    A method to get the first Key of a Map.
    
    Specified by:
    
    firstCharKey in interface Char2ShortSortedMap
    
    Returns:
    
    the first key in the map
  - pollFirstCharKey
```
public char pollFirstCharKey()
```
    Description copied from interface: Char2ShortSortedMap
    
    A method to get and remove the first Key of a Map.
    
    Specified by:
    
    pollFirstCharKey in interface Char2ShortSortedMap
    
    Returns:
    
    the first key in the map
  - lastCharKey
```
public char lastCharKey()
```
    Description copied from interface: Char2ShortSortedMap
    
    A method to get the last Key of a Map.
    
    Specified by:
    
    lastCharKey in interface Char2ShortSortedMap
    
    Returns:
    
    the last key in the map
  - pollLastCharKey
```
public char pollLastCharKey()
```
    Description copied from interface: Char2ShortSortedMap
    
    A method to get and remove the last Key of a Map.
    
    Specified by:
    
    pollLastCharKey in interface Char2ShortSortedMap
    
    Returns:
    
    the last key in the map
  - firstEntry
```
public Char2ShortMap.Entry firstEntry()
```
    Specified by:
    
    firstEntry in interface java.util.NavigableMap<java.lang.Character,java.lang.Short>
    
    Specified by:
    
    firstEntry in interface Char2ShortNavigableMap
    
    Returns:
    
    a Type Specific firstEntry
  - lastEntry
```
public Char2ShortMap.Entry lastEntry()
```
    Specified by:
    
    lastEntry in interface java.util.NavigableMap<java.lang.Character,java.lang.Short>
    
    Specified by:
    
    lastEntry in interface Char2ShortNavigableMap
    
    Returns:
    
    a Type Specific lastEntry
  - pollFirstEntry
```
public Char2ShortMap.Entry pollFirstEntry()
```
    Specified by:
    
    pollFirstEntry in interface java.util.NavigableMap<java.lang.Character,java.lang.Short>
    
    Specified by:
    
    pollFirstEntry in interface Char2ShortNavigableMap
    
    Returns:
    
    a Type Specific pollFirstEntry
  - pollLastEntry
```
public Char2ShortMap.Entry pollLastEntry()
```
    Specified by:
    
    pollLastEntry in interface java.util.NavigableMap<java.lang.Character,java.lang.Short>
    
    Specified by:
    
    pollLastEntry in interface Char2ShortNavigableMap
    
    Returns:
    
    a Type Specific pollLastEntry
  - firstShortValue
```
public short firstShortValue()
```
    Description copied from interface: Char2ShortSortedMap
    
    A method to get the first Value of a Map.
    
    Specified by:
    
    firstShortValue in interface Char2ShortSortedMap
    
    Returns:
    
    the first key in the map
  - lastShortValue
```
public short lastShortValue()
```
    Description copied from interface: Char2ShortSortedMap
    
    A method to get the last Value of a Map.
    
    Specified by:
    
    lastShortValue in interface Char2ShortSortedMap
    
    Returns:
    
    the last key in the map
  - remove
```
public short remove(char key)
```
    Description copied from interface: Char2ShortMap
    
    Type Specific remove function to reduce boxing/unboxing
    
    Specified by:
    
    remove in interface Char2ShortMap
    
    Parameters:
    
    key - the element that should be removed
    
    Returns:
    
    the value that was removed or default return value
  - removeOrDefault
```
public short removeOrDefault(char key,
                             short defaultValue)
```
    Description copied from interface: Char2ShortMap
    
    Type-Specific Remove function with a default return value if wanted.
    
    Specified by:
    
    removeOrDefault in interface Char2ShortMap
    
    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(char key,
                      short value)
```
    Description copied from interface: Char2ShortMap
    
    Type Specific remove function to reduce boxing/unboxing
    
    Specified by:
    
    remove in interface Char2ShortMap
    
    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(char key,
                       short oldValue,
                       short newValue)
```
    Description copied from interface: Char2ShortMap
    
    A Type Specific replace method to replace an existing value
    
    Specified by:
    
    replace in interface Char2ShortMap
    
    Overrides:
    
    replace in class AbstractChar2ShortMap
    
    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 short replace(char key,
                     short value)
```
    Description copied from interface: Char2ShortMap
    
    A Type Specific replace method to reduce boxing/unboxing replace an existing value
    
    Specified by:
    
    replace in interface Char2ShortMap
    
    Overrides:
    
    replace in class AbstractChar2ShortMap
    
    Parameters:
    
    key - the element that should be searched for
    
    value - the value to replace with.
    
    Returns:
    
    the present value or default return value
  - computeShort
```
public short computeShort(char key,
                          CharShortUnaryOperator mappingFunction)
```
    Description copied from interface: Char2ShortMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeShort in interface Char2ShortMap
    
    Overrides:
    
    computeShort in class AbstractChar2ShortMap
    
    Parameters:
    
    key - the key that should be computed
    
    mappingFunction - the operator that should generate the value
    
    Returns:
    
    the result of the computation
  - computeShortIfAbsent
```
public short computeShortIfAbsent(char key,
                                  Char2ShortFunction mappingFunction)
```
    Description copied from interface: Char2ShortMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeShortIfAbsent in interface Char2ShortMap
    
    Overrides:
    
    computeShortIfAbsent in class AbstractChar2ShortMap
    
    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
  - supplyShortIfAbsent
```
public short supplyShortIfAbsent(char key,
                                 ShortSupplier valueProvider)
```
    Description copied from interface: Char2ShortMap
    
    A Supplier based computeIfAbsent function to fill the most used usecase of this function
    
    Specified by:
    
    supplyShortIfAbsent in interface Char2ShortMap
    
    Overrides:
    
    supplyShortIfAbsent in class AbstractChar2ShortMap
    
    Parameters:
    
    key - the key that should be computed
    
    valueProvider - the value if not present
    
    Returns:
    
    the result of the computed value or present value
  - computeShortIfPresent
```
public short computeShortIfPresent(char key,
                                   CharShortUnaryOperator mappingFunction)
```
    Description copied from interface: Char2ShortMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeShortIfPresent in interface Char2ShortMap
    
    Overrides:
    
    computeShortIfPresent in class AbstractChar2ShortMap
    
    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
  - mergeShort
```
public short mergeShort(char key,
                        short value,
                        ShortShortUnaryOperator mappingFunction)
```
    Description copied from interface: Char2ShortMap
    
    A Type Specific merge method to reduce boxing/unboxing
    
    Specified by:
    
    mergeShort in interface Char2ShortMap
    
    Overrides:
    
    mergeShort in class AbstractChar2ShortMap
    
    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
  - mergeAllShort
```
public void mergeAllShort(Char2ShortMap m,
                          ShortShortUnaryOperator mappingFunction)
```
    Description copied from interface: Char2ShortMap
    
    A Bulk method for merging Maps.
    
    Specified by:
    
    mergeAllShort in interface Char2ShortMap
    
    Overrides:
    
    mergeAllShort in class AbstractChar2ShortMap
    
    Parameters:
    
    m - the entries that should be bulk added
    
    mappingFunction - the operator that should generate the new Value
  - forEach
```
public void forEach(CharShortConsumer action)
```
    Description copied from interface: Char2ShortMap
    
    Type Specific forEach method to reduce boxing/unboxing
    
    Specified by:
    
    forEach in interface Char2ShortMap
    
    Overrides:
    
    forEach in class AbstractChar2ShortMap
    
    Parameters:
    
    action - processor of the values that are iterator over
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Map<java.lang.Character,java.lang.Short>
    
    Overrides:
    
    size in class java.util.AbstractMap<java.lang.Character,java.lang.Short>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<java.lang.Character,java.lang.Short>
    
    Overrides:
    
    clear in class java.util.AbstractMap<java.lang.Character,java.lang.Short>
  - copy
```
public Char2ShortRBTreeMap copy()
```
    Description copied from interface: Char2ShortMap
    
    A Function that does a shallow clone of the Map itself. This function is more optimized then a copy constructor since the Map does not have to be unsorted/resorted. It can be compared to Cloneable but with less exception risk
    
    Specified by:
    
    copy in interface Char2ShortMap
    
    Specified by:
    
    copy in interface Char2ShortNavigableMap
    
    Specified by:
    
    copy in interface Char2ShortSortedMap
    
    Overrides:
    
    copy in class AbstractChar2ShortMap
    
    Returns:
    
    a Shallow Copy of the Map
  - keySet
```
public CharNavigableSet keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Character,java.lang.Short>
    
    Specified by:
    
    keySet in interface java.util.SortedMap<java.lang.Character,java.lang.Short>
    
    Specified by:
    
    keySet in interface Char2ShortMap
    
    Specified by:
    
    keySet in interface Char2ShortNavigableMap
    
    Specified by:
    
    keySet in interface Char2ShortSortedMap
    
    Overrides:
    
    keySet in class AbstractChar2ShortMap
    
    Returns:
    
    a Type Specific Navigable Key Set
  - char2ShortEntrySet
```
public ObjectSet<Char2ShortMap.Entry> char2ShortEntrySet()
```
    Description copied from interface: Char2ShortMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Specified by:
    
    char2ShortEntrySet in interface Char2ShortMap
    
    Returns:
    
    a EntrySet of the collection
  - values
```
public ShortCollection values()
```
    Specified by:
    
    values in interface java.util.Map<java.lang.Character,java.lang.Short>
    
    Specified by:
    
    values in interface java.util.SortedMap<java.lang.Character,java.lang.Short>
    
    Specified by:
    
    values in interface Char2ShortMap
    
    Specified by:
    
    values in interface Char2ShortSortedMap
    
    Overrides:
    
    values in class AbstractChar2ShortMap
  - navigableKeySet
```
public CharNavigableSet navigableKeySet()
```
    Specified by:
    
    navigableKeySet in interface java.util.NavigableMap<java.lang.Character,java.lang.Short>
    
    Specified by:
    
    navigableKeySet in interface Char2ShortNavigableMap
    
    Returns:
    
    a Type Specific Navigable Key Set
  - descendingMap
```
public Char2ShortNavigableMap descendingMap()
```
    Specified by:
    
    descendingMap in interface java.util.NavigableMap<java.lang.Character,java.lang.Short>
    
    Specified by:
    
    descendingMap in interface Char2ShortNavigableMap
    
    Returns:
    
    a Type Specific desendingMap
  - descendingKeySet
```
public CharNavigableSet descendingKeySet()
```
    Specified by:
    
    descendingKeySet in interface java.util.NavigableMap<java.lang.Character,java.lang.Short>
    
    Specified by:
    
    descendingKeySet in interface Char2ShortNavigableMap
    
    Returns:
    
    a Type Specific Desending Key Set
  - subMap
```
public Char2ShortNavigableMap subMap(char fromKey,
                                     boolean fromInclusive,
                                     char toKey,
                                     boolean toInclusive)
```
    Description copied from interface: Char2ShortNavigableMap
    
    A Type Specific SubMap method to reduce boxing/unboxing
    
    Specified by:
    
    subMap in interface Char2ShortNavigableMap
    
    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 Char2ShortNavigableMap headMap(char toKey,
                                      boolean inclusive)
```
    Description copied from interface: Char2ShortNavigableMap
    
    A Type Specific HeadMap method to reduce boxing/unboxing
    
    Specified by:
    
    headMap in interface Char2ShortNavigableMap
    
    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 Char2ShortNavigableMap tailMap(char fromKey,
                                      boolean inclusive)
```
    Description copied from interface: Char2ShortNavigableMap
    
    A Type Specific TailMap method to reduce boxing/unboxing
    
    Specified by:
    
    tailMap in interface Char2ShortNavigableMap
    
    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 char lowerKey(char e)
```
    Description copied from interface: Char2ShortNavigableMap
    
    A Type Specific lowerKey method to reduce boxing/unboxing.
    
    Specified by:
    
    lowerKey in interface Char2ShortNavigableMap
    
    Parameters:
    
    e - that should be compared with.
    
    Returns:
    
    the greatest lower key that can be found
  - floorKey
```
public char floorKey(char e)
```
    Description copied from interface: Char2ShortNavigableMap
    
    A Type Specific floorKey method to reduce boxing/unboxing.
    
    Specified by:
    
    floorKey in interface Char2ShortNavigableMap
    
    Parameters:
    
    e - that should be compared with.
    
    Returns:
    
    the greatest lower or equal key that can be found
  - higherKey
```
public char higherKey(char e)
```
    Description copied from interface: Char2ShortNavigableMap
    
    A Type Specific higherKey method to reduce boxing/unboxing.
    
    Specified by:
    
    higherKey in interface Char2ShortNavigableMap
    
    Parameters:
    
    e - that should be compared with.
    
    Returns:
    
    the lowest higher key that can be found
  - ceilingKey
```
public char ceilingKey(char e)
```
    Description copied from interface: Char2ShortNavigableMap
    
    A Type Specific ceilingKey method to reduce boxing/unboxing.
    
    Specified by:
    
    ceilingKey in interface Char2ShortNavigableMap
    
    Parameters:
    
    e - that should be compared with.
    
    Returns:
    
    the lowest higher or equal key that can be found
  - lowerEntry
```
public Char2ShortMap.Entry lowerEntry(char key)
```
    Description copied from interface: Char2ShortNavigableMap
    
    A Type Specific lowerEntry method to reduce boxing/unboxing.
    
    Specified by:
    
    lowerEntry in interface Char2ShortNavigableMap
    
    Parameters:
    
    key - that should be compared with.
    
    Returns:
    
    the greatest lower entry that can be found, or null
  - higherEntry
```
public Char2ShortMap.Entry higherEntry(char key)
```
    Description copied from interface: Char2ShortNavigableMap
    
    A Type Specific higherEntry method to reduce boxing/unboxing.
    
    Specified by:
    
    higherEntry in interface Char2ShortNavigableMap
    
    Parameters:
    
    key - that should be compared with.
    
    Returns:
    
    the lowest higher entry that can be found, or null
  - floorEntry
```
public Char2ShortMap.Entry floorEntry(char key)
```
    Description copied from interface: Char2ShortNavigableMap
    
    A Type Specific floorEntry method to reduce boxing/unboxing.
    
    Specified by:
    
    floorEntry in interface Char2ShortNavigableMap
    
    Parameters:
    
    key - that should be compared with.
    
    Returns:
    
    the greatest lower or equal entry that can be found, or null
  - ceilingEntry
```
public Char2ShortMap.Entry ceilingEntry(char key)
```
    Description copied from interface: Char2ShortNavigableMap
    
    A Type Specific ceilingEntry method to reduce boxing/unboxing.
    
    Specified by:
    
    ceilingEntry in interface Char2ShortNavigableMap
    
    Parameters:
    
    key - that should be compared with.
    
    Returns:
    
    the lowest higher or equal entry that can be found, or null

Class Char2ShortRBTreeMap

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.chars.maps.abstracts.AbstractChar2ShortMap

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

Nested classes/interfaces inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ShortSortedMap

Nested classes/interfaces inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ShortMap

Constructor Summary

Method Summary

Methods inherited from class speiger.src.collections.chars.maps.abstracts.AbstractChar2ShortMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ShortNavigableMap

Methods inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ShortSortedMap

Methods inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ShortMap

Methods inherited from interface java.util.SortedMap

Methods inherited from interface java.util.Map

Constructor Detail

Char2ShortRBTreeMap

Char2ShortRBTreeMap

Char2ShortRBTreeMap

Char2ShortRBTreeMap

Char2ShortRBTreeMap

Char2ShortRBTreeMap

Char2ShortRBTreeMap

Char2ShortRBTreeMap

Char2ShortRBTreeMap

Char2ShortRBTreeMap

Method Detail

setDefaultMaxValue

getDefaultMaxValue

setDefaultMinValue

getDefaultMinValue

put

putIfAbsent

addTo

subFrom

comparator

containsKey

get

getOrDefault

firstCharKey

pollFirstCharKey

lastCharKey

pollLastCharKey

firstEntry

lastEntry

pollFirstEntry

pollLastEntry

firstShortValue

lastShortValue

remove

removeOrDefault

remove

replace

replace

computeShort

computeShortIfAbsent

supplyShortIfAbsent

computeShortIfPresent

mergeShort

mergeAllShort

forEach

size

clear

copy

keySet

char2ShortEntrySet

values

navigableKeySet

descendingMap

descendingKeySet

subMap

headMap

tailMap

lowerKey

floorKey

higherKey

ceilingKey

lowerEntry

higherEntry