Int2CharRBTreeMap (Primitive-Collections 0.7.0 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Integer,java.lang.Character>
- - speiger.src.collections.ints.maps.abstracts.AbstractInt2CharMap
  - - speiger.src.collections.ints.maps.impl.tree.Int2CharRBTreeMap

All Implemented Interfaces:

java.util.Map<java.lang.Integer,java.lang.Character>, java.util.NavigableMap<java.lang.Integer,java.lang.Character>, java.util.SortedMap<java.lang.Integer,java.lang.Character>, Int2CharFunction, Int2CharMap, Int2CharNavigableMap, Int2CharSortedMap
```
public class Int2CharRBTreeMap
extends AbstractInt2CharMap
implements Int2CharNavigableMap
```
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.ints.maps.abstracts.AbstractInt2CharMap
  AbstractInt2CharMap.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.ints.maps.interfaces.Int2CharSortedMap
  Int2CharSortedMap.FastSortedSet
- Nested classes/interfaces inherited from interface speiger.src.collections.ints.maps.interfaces.Int2CharMap
  Int2CharMap.BuilderCache, Int2CharMap.Entry, Int2CharMap.FastEntrySet, Int2CharMap.MapBuilder

Constructor Summary

Constructors
Constructor and Description
`Int2CharRBTreeMap()` Default Constructor
`Int2CharRBTreeMap(int[] keys, char[] values)` Helper constructor that allow to create a map from unboxed values
`Int2CharRBTreeMap(int[] keys, char[] values, IntComparator comp)` Helper constructor that has a custom sorter and allow to create a map from unboxed values
`Int2CharRBTreeMap(Int2CharMap map)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`Int2CharRBTreeMap(Int2CharMap map, IntComparator 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.
`Int2CharRBTreeMap(IntComparator comp)` Constructor that allows to define the sorter
`Int2CharRBTreeMap(java.lang.Integer[] keys, java.lang.Character[] values)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`Int2CharRBTreeMap(java.lang.Integer[] keys, java.lang.Character[] values, IntComparator comp)` Helper constructor that has a custom sorter and allow to create a map from boxed values (it will unbox them)
`Int2CharRBTreeMap(java.util.Map<? extends java.lang.Integer,? extends java.lang.Character> map)` A Helper constructor that allows to create a Map with exactly the same values as the provided map.
`Int2CharRBTreeMap(java.util.Map<? extends java.lang.Integer,? extends java.lang.Character> map, IntComparator 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
`char`	`addTo(int key, char value)` A Helper method to add a primitives together.
`Int2CharMap.Entry`	`ceilingEntry(int key)` A Type Specific ceilingEntry method to reduce boxing/unboxing.
`int`	`ceilingKey(int e)` A Type Specific ceilingKey method to reduce boxing/unboxing.
`void`	`clear()`
`IntComparator`	`comparator()`
`char`	`computeChar(int key, IntCharUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`char`	`computeCharIfAbsent(int key, Int2CharFunction mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`char`	`computeCharIfPresent(int key, IntCharUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`boolean`	`containsKey(int key)` Type Specific method to reduce boxing/unboxing of values
`Int2CharRBTreeMap`	`copy()` A Function that does a shallow clone of the Map itself.
`IntNavigableSet`	`descendingKeySet()`
`Int2CharNavigableMap`	`descendingMap()`
`char`	`firstCharValue()` A method to get the first Value of a Map.
`Int2CharMap.Entry`	`firstEntry()`
`int`	`firstIntKey()` A method to get the first Key of a Map.
`Int2CharMap.Entry`	`floorEntry(int key)` A Type Specific floorEntry method to reduce boxing/unboxing.
`int`	`floorKey(int e)` A Type Specific floorKey method to reduce boxing/unboxing.
`void`	`forEach(IntCharConsumer action)` Type Specific forEach method to reduce boxing/unboxing
`char`	`get(int key)` A Type Specific get method to reduce boxing/unboxing
`int`	`getDefaultMaxValue()` A Helper method to get the max value for SubMaps.
`int`	`getDefaultMinValue()` A Helper method to get the min value for SubMaps.
`char`	`getOrDefault(int key, char defaultValue)` A Type Specific getOrDefault method to reduce boxing/unboxing
`Int2CharNavigableMap`	`headMap(int toKey, boolean inclusive)` A Type Specific HeadMap method to reduce boxing/unboxing
`Int2CharMap.Entry`	`higherEntry(int key)` A Type Specific higherEntry method to reduce boxing/unboxing.
`int`	`higherKey(int e)` A Type Specific higherKey method to reduce boxing/unboxing.
`ObjectSet<Int2CharMap.Entry>`	`int2CharEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`IntNavigableSet`	`keySet()`
`char`	`lastCharValue()` A method to get the last Value of a Map.
`Int2CharMap.Entry`	`lastEntry()`
`int`	`lastIntKey()` A method to get the last Key of a Map.
`Int2CharMap.Entry`	`lowerEntry(int key)` A Type Specific lowerEntry method to reduce boxing/unboxing.
`int`	`lowerKey(int e)` A Type Specific lowerKey method to reduce boxing/unboxing.
`void`	`mergeAllChar(Int2CharMap m, CharCharUnaryOperator mappingFunction)` A Bulk method for merging Maps.
`char`	`mergeChar(int key, char value, CharCharUnaryOperator mappingFunction)` A Type Specific merge method to reduce boxing/unboxing
`IntNavigableSet`	`navigableKeySet()`
`Int2CharMap.Entry`	`pollFirstEntry()`
`int`	`pollFirstIntKey()` A method to get and remove the first Key of a Map.
`Int2CharMap.Entry`	`pollLastEntry()`
`int`	`pollLastIntKey()` A method to get and remove the last Key of a Map.
`char`	`put(int key, char value)` Type Specific method to reduce boxing/unboxing of values
`char`	`putIfAbsent(int key, char value)` Type Specific method to reduce boxing/unboxing of values
`char`	`remove(int key)` Type Specific remove function to reduce boxing/unboxing
`boolean`	`remove(int key, char value)` Type Specific remove function to reduce boxing/unboxing
`char`	`removeOrDefault(int key, char defaultValue)` Type-Specific Remove function with a default return value if wanted.
`char`	`replace(int key, char value)` A Type Specific replace method to reduce boxing/unboxing replace an existing value
`boolean`	`replace(int key, char oldValue, char newValue)` A Type Specific replace method to replace an existing value
`void`	`setDefaultMaxValue(int value)` A Helper method to set the max value for SubMaps.
`void`	`setDefaultMinValue(int value)` A Helper method to set the min value for SubMaps.
`int`	`size()`
`char`	`subFrom(int key, char value)` A Helper method to subtract from primitive from each other.
`Int2CharNavigableMap`	`subMap(int fromKey, boolean fromInclusive, int toKey, boolean toInclusive)` A Type Specific SubMap method to reduce boxing/unboxing
`char`	`supplyCharIfAbsent(int key, CharSupplier valueProvider)` A Supplier based computeIfAbsent function to fill the most used usecase of this function
`Int2CharNavigableMap`	`tailMap(int fromKey, boolean inclusive)` A Type Specific TailMap method to reduce boxing/unboxing
`CharCollection`	`values()`

Methods inherited from class speiger.src.collections.ints.maps.abstracts.AbstractInt2CharMap
addToAll, containsValue, entrySet, equals, get, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, remove, replaceChars, replaceChars, 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.ints.maps.interfaces.Int2CharNavigableMap
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.ints.maps.interfaces.Int2CharSortedMap
firstKey, lastKey

Methods inherited from interface speiger.src.collections.ints.maps.interfaces.Int2CharMap
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, replaceChars, replaceChars, setDefaultReturnValue

Methods inherited from interface java.util.SortedMap
entrySet

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

- Constructor Detail
  - Int2CharRBTreeMap
```
public Int2CharRBTreeMap()
```
    Default Constructor
  - Int2CharRBTreeMap
```
public Int2CharRBTreeMap(IntComparator comp)
```
    Constructor that allows to define the sorter
    
    Parameters:
    
    comp - the function that decides how the tree is sorted, can be null
  - Int2CharRBTreeMap
```
public Int2CharRBTreeMap(java.lang.Integer[] keys,
                         java.lang.Character[] 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
  - Int2CharRBTreeMap
```
public Int2CharRBTreeMap(java.lang.Integer[] keys,
                         java.lang.Character[] values,
                         IntComparator 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
  - Int2CharRBTreeMap
```
public Int2CharRBTreeMap(int[] keys,
                         char[] 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
  - Int2CharRBTreeMap
```
public Int2CharRBTreeMap(int[] keys,
                         char[] values,
                         IntComparator 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
  - Int2CharRBTreeMap
```
public Int2CharRBTreeMap(java.util.Map<? extends java.lang.Integer,? extends java.lang.Character> 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
  - Int2CharRBTreeMap
```
public Int2CharRBTreeMap(java.util.Map<? extends java.lang.Integer,? extends java.lang.Character> map,
                         IntComparator 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
  - Int2CharRBTreeMap
```
public Int2CharRBTreeMap(Int2CharMap 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
  - Int2CharRBTreeMap
```
public Int2CharRBTreeMap(Int2CharMap map,
                         IntComparator 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(int value)
```
    Description copied from interface: Int2CharNavigableMap
    
    A Helper method to set the max value for SubMaps. (Default: int.MIN_VALUE)
    
    Specified by:
    
    setDefaultMaxValue in interface Int2CharNavigableMap
    
    Parameters:
    
    value - the new max value
  - getDefaultMaxValue
```
public int getDefaultMaxValue()
```
    Description copied from interface: Int2CharNavigableMap
    
    A Helper method to get the max value for SubMaps.
    
    Specified by:
    
    getDefaultMaxValue in interface Int2CharNavigableMap
    
    Returns:
    
    the default max value.
  - setDefaultMinValue
```
public void setDefaultMinValue(int value)
```
    Description copied from interface: Int2CharNavigableMap
    
    A Helper method to set the min value for SubMaps. (Default: int.MAX_VALUE)
    
    Specified by:
    
    setDefaultMinValue in interface Int2CharNavigableMap
    
    Parameters:
    
    value - the new min value
  - getDefaultMinValue
```
public int getDefaultMinValue()
```
    Description copied from interface: Int2CharNavigableMap
    
    A Helper method to get the min value for SubMaps.
    
    Specified by:
    
    getDefaultMinValue in interface Int2CharNavigableMap
    
    Returns:
    
    the default min value.
  - put
```
public char put(int key,
                char value)
```
    Description copied from interface: Int2CharMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    put in interface Int2CharMap
    
    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 char putIfAbsent(int key,
                        char value)
```
    Description copied from interface: Int2CharMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    putIfAbsent in interface Int2CharMap
    
    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 char addTo(int key,
                  char value)
```
    Description copied from interface: Int2CharMap
    
    A Helper method to add a primitives together. If key is not present then this functions as a put.
    
    Specified by:
    
    addTo in interface Int2CharMap
    
    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 char subFrom(int key,
                    char value)
```
    Description copied from interface: Int2CharMap
    
    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 Int2CharMap.getDefaultReturnValue() If the fence is reached the element will be automaticall removed
    
    Specified by:
    
    subFrom in interface Int2CharMap
    
    Parameters:
    
    key - that should be subtract from
    
    value - that should be subtract
    
    Returns:
    
    the last present or default return value
  - comparator
```
public IntComparator comparator()
```
    Specified by:
    
    comparator in interface java.util.SortedMap<java.lang.Integer,java.lang.Character>
    
    Specified by:
    
    comparator in interface Int2CharSortedMap
  - containsKey
```
public boolean containsKey(int key)
```
    Description copied from interface: Int2CharMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    containsKey in interface Int2CharMap
    
    Overrides:
    
    containsKey in class AbstractInt2CharMap
    
    Parameters:
    
    key - element that is searched for
    
    Returns:
    
    if the key is present
  - get
```
public char get(int key)
```
    Description copied from interface: Int2CharMap
    
    A Type Specific get method to reduce boxing/unboxing
    
    Specified by:
    
    get in interface Int2CharFunction
    
    Specified by:
    
    get in interface Int2CharMap
    
    Parameters:
    
    key - the key that is searched for
    
    Returns:
    
    the searched value or default return value
  - getOrDefault
```
public char getOrDefault(int key,
                         char defaultValue)
```
    Description copied from interface: Int2CharMap
    
    A Type Specific getOrDefault method to reduce boxing/unboxing
    
    Specified by:
    
    getOrDefault in interface Int2CharMap
    
    Overrides:
    
    getOrDefault in class AbstractInt2CharMap
    
    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
  - firstIntKey
```
public int firstIntKey()
```
    Description copied from interface: Int2CharSortedMap
    
    A method to get the first Key of a Map.
    
    Specified by:
    
    firstIntKey in interface Int2CharSortedMap
    
    Returns:
    
    the first key in the map
  - pollFirstIntKey
```
public int pollFirstIntKey()
```
    Description copied from interface: Int2CharSortedMap
    
    A method to get and remove the first Key of a Map.
    
    Specified by:
    
    pollFirstIntKey in interface Int2CharSortedMap
    
    Returns:
    
    the first key in the map
  - lastIntKey
```
public int lastIntKey()
```
    Description copied from interface: Int2CharSortedMap
    
    A method to get the last Key of a Map.
    
    Specified by:
    
    lastIntKey in interface Int2CharSortedMap
    
    Returns:
    
    the last key in the map
  - pollLastIntKey
```
public int pollLastIntKey()
```
    Description copied from interface: Int2CharSortedMap
    
    A method to get and remove the last Key of a Map.
    
    Specified by:
    
    pollLastIntKey in interface Int2CharSortedMap
    
    Returns:
    
    the last key in the map
  - firstEntry
```
public Int2CharMap.Entry firstEntry()
```
    Specified by:
    
    firstEntry in interface java.util.NavigableMap<java.lang.Integer,java.lang.Character>
    
    Specified by:
    
    firstEntry in interface Int2CharNavigableMap
    
    Returns:
    
    a Type Specific firstEntry
  - lastEntry
```
public Int2CharMap.Entry lastEntry()
```
    Specified by:
    
    lastEntry in interface java.util.NavigableMap<java.lang.Integer,java.lang.Character>
    
    Specified by:
    
    lastEntry in interface Int2CharNavigableMap
    
    Returns:
    
    a Type Specific lastEntry
  - pollFirstEntry
```
public Int2CharMap.Entry pollFirstEntry()
```
    Specified by:
    
    pollFirstEntry in interface java.util.NavigableMap<java.lang.Integer,java.lang.Character>
    
    Specified by:
    
    pollFirstEntry in interface Int2CharNavigableMap
    
    Returns:
    
    a Type Specific pollFirstEntry
  - pollLastEntry
```
public Int2CharMap.Entry pollLastEntry()
```
    Specified by:
    
    pollLastEntry in interface java.util.NavigableMap<java.lang.Integer,java.lang.Character>
    
    Specified by:
    
    pollLastEntry in interface Int2CharNavigableMap
    
    Returns:
    
    a Type Specific pollLastEntry
  - firstCharValue
```
public char firstCharValue()
```
    Description copied from interface: Int2CharSortedMap
    
    A method to get the first Value of a Map.
    
    Specified by:
    
    firstCharValue in interface Int2CharSortedMap
    
    Returns:
    
    the first key in the map
  - lastCharValue
```
public char lastCharValue()
```
    Description copied from interface: Int2CharSortedMap
    
    A method to get the last Value of a Map.
    
    Specified by:
    
    lastCharValue in interface Int2CharSortedMap
    
    Returns:
    
    the last key in the map
  - remove
```
public char remove(int key)
```
    Description copied from interface: Int2CharMap
    
    Type Specific remove function to reduce boxing/unboxing
    
    Specified by:
    
    remove in interface Int2CharMap
    
    Parameters:
    
    key - the element that should be removed
    
    Returns:
    
    the value that was removed or default return value
  - removeOrDefault
```
public char removeOrDefault(int key,
                            char defaultValue)
```
    Description copied from interface: Int2CharMap
    
    Type-Specific Remove function with a default return value if wanted.
    
    Specified by:
    
    removeOrDefault in interface Int2CharMap
    
    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(int key,
                      char value)
```
    Description copied from interface: Int2CharMap
    
    Type Specific remove function to reduce boxing/unboxing
    
    Specified by:
    
    remove in interface Int2CharMap
    
    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(int key,
                       char oldValue,
                       char newValue)
```
    Description copied from interface: Int2CharMap
    
    A Type Specific replace method to replace an existing value
    
    Specified by:
    
    replace in interface Int2CharMap
    
    Overrides:
    
    replace in class AbstractInt2CharMap
    
    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 char replace(int key,
                    char value)
```
    Description copied from interface: Int2CharMap
    
    A Type Specific replace method to reduce boxing/unboxing replace an existing value
    
    Specified by:
    
    replace in interface Int2CharMap
    
    Overrides:
    
    replace in class AbstractInt2CharMap
    
    Parameters:
    
    key - the element that should be searched for
    
    value - the value to replace with.
    
    Returns:
    
    the present value or default return value
  - computeChar
```
public char computeChar(int key,
                        IntCharUnaryOperator mappingFunction)
```
    Description copied from interface: Int2CharMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeChar in interface Int2CharMap
    
    Overrides:
    
    computeChar in class AbstractInt2CharMap
    
    Parameters:
    
    key - the key that should be computed
    
    mappingFunction - the operator that should generate the value
    
    Returns:
    
    the result of the computation
  - computeCharIfAbsent
```
public char computeCharIfAbsent(int key,
                                Int2CharFunction mappingFunction)
```
    Description copied from interface: Int2CharMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeCharIfAbsent in interface Int2CharMap
    
    Overrides:
    
    computeCharIfAbsent in class AbstractInt2CharMap
    
    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
  - supplyCharIfAbsent
```
public char supplyCharIfAbsent(int key,
                               CharSupplier valueProvider)
```
    Description copied from interface: Int2CharMap
    
    A Supplier based computeIfAbsent function to fill the most used usecase of this function
    
    Specified by:
    
    supplyCharIfAbsent in interface Int2CharMap
    
    Overrides:
    
    supplyCharIfAbsent in class AbstractInt2CharMap
    
    Parameters:
    
    key - the key that should be computed
    
    valueProvider - the value if not present
    
    Returns:
    
    the result of the computed value or present value
  - computeCharIfPresent
```
public char computeCharIfPresent(int key,
                                 IntCharUnaryOperator mappingFunction)
```
    Description copied from interface: Int2CharMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeCharIfPresent in interface Int2CharMap
    
    Overrides:
    
    computeCharIfPresent in class AbstractInt2CharMap
    
    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
  - mergeChar
```
public char mergeChar(int key,
                      char value,
                      CharCharUnaryOperator mappingFunction)
```
    Description copied from interface: Int2CharMap
    
    A Type Specific merge method to reduce boxing/unboxing
    
    Specified by:
    
    mergeChar in interface Int2CharMap
    
    Overrides:
    
    mergeChar in class AbstractInt2CharMap
    
    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
  - mergeAllChar
```
public void mergeAllChar(Int2CharMap m,
                         CharCharUnaryOperator mappingFunction)
```
    Description copied from interface: Int2CharMap
    
    A Bulk method for merging Maps.
    
    Specified by:
    
    mergeAllChar in interface Int2CharMap
    
    Overrides:
    
    mergeAllChar in class AbstractInt2CharMap
    
    Parameters:
    
    m - the entries that should be bulk added
    
    mappingFunction - the operator that should generate the new Value
  - forEach
```
public void forEach(IntCharConsumer action)
```
    Description copied from interface: Int2CharMap
    
    Type Specific forEach method to reduce boxing/unboxing
    
    Specified by:
    
    forEach in interface Int2CharMap
    
    Overrides:
    
    forEach in class AbstractInt2CharMap
    
    Parameters:
    
    action - processor of the values that are iterator over
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Map<java.lang.Integer,java.lang.Character>
    
    Overrides:
    
    size in class java.util.AbstractMap<java.lang.Integer,java.lang.Character>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<java.lang.Integer,java.lang.Character>
    
    Overrides:
    
    clear in class java.util.AbstractMap<java.lang.Integer,java.lang.Character>
  - copy
```
public Int2CharRBTreeMap copy()
```
    Description copied from interface: Int2CharMap
    
    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 Int2CharMap
    
    Specified by:
    
    copy in interface Int2CharNavigableMap
    
    Specified by:
    
    copy in interface Int2CharSortedMap
    
    Overrides:
    
    copy in class AbstractInt2CharMap
    
    Returns:
    
    a Shallow Copy of the Map
  - keySet
```
public IntNavigableSet keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Integer,java.lang.Character>
    
    Specified by:
    
    keySet in interface java.util.SortedMap<java.lang.Integer,java.lang.Character>
    
    Specified by:
    
    keySet in interface Int2CharMap
    
    Specified by:
    
    keySet in interface Int2CharNavigableMap
    
    Specified by:
    
    keySet in interface Int2CharSortedMap
    
    Overrides:
    
    keySet in class AbstractInt2CharMap
    
    Returns:
    
    a Type Specific Navigable Key Set
  - int2CharEntrySet
```
public ObjectSet<Int2CharMap.Entry> int2CharEntrySet()
```
    Description copied from interface: Int2CharMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Specified by:
    
    int2CharEntrySet in interface Int2CharMap
    
    Returns:
    
    a EntrySet of the collection
  - values
```
public CharCollection values()
```
    Specified by:
    
    values in interface java.util.Map<java.lang.Integer,java.lang.Character>
    
    Specified by:
    
    values in interface java.util.SortedMap<java.lang.Integer,java.lang.Character>
    
    Specified by:
    
    values in interface Int2CharMap
    
    Specified by:
    
    values in interface Int2CharSortedMap
    
    Overrides:
    
    values in class AbstractInt2CharMap
  - navigableKeySet
```
public IntNavigableSet navigableKeySet()
```
    Specified by:
    
    navigableKeySet in interface java.util.NavigableMap<java.lang.Integer,java.lang.Character>
    
    Specified by:
    
    navigableKeySet in interface Int2CharNavigableMap
    
    Returns:
    
    a Type Specific Navigable Key Set
  - descendingMap
```
public Int2CharNavigableMap descendingMap()
```
    Specified by:
    
    descendingMap in interface java.util.NavigableMap<java.lang.Integer,java.lang.Character>
    
    Specified by:
    
    descendingMap in interface Int2CharNavigableMap
    
    Returns:
    
    a Type Specific desendingMap
  - descendingKeySet
```
public IntNavigableSet descendingKeySet()
```
    Specified by:
    
    descendingKeySet in interface java.util.NavigableMap<java.lang.Integer,java.lang.Character>
    
    Specified by:
    
    descendingKeySet in interface Int2CharNavigableMap
    
    Returns:
    
    a Type Specific Desending Key Set
  - subMap
```
public Int2CharNavigableMap subMap(int fromKey,
                                   boolean fromInclusive,
                                   int toKey,
                                   boolean toInclusive)
```
    Description copied from interface: Int2CharNavigableMap
    
    A Type Specific SubMap method to reduce boxing/unboxing
    
    Specified by:
    
    subMap in interface Int2CharNavigableMap
    
    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 Int2CharNavigableMap headMap(int toKey,
                                    boolean inclusive)
```
    Description copied from interface: Int2CharNavigableMap
    
    A Type Specific HeadMap method to reduce boxing/unboxing
    
    Specified by:
    
    headMap in interface Int2CharNavigableMap
    
    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 Int2CharNavigableMap tailMap(int fromKey,
                                    boolean inclusive)
```
    Description copied from interface: Int2CharNavigableMap
    
    A Type Specific TailMap method to reduce boxing/unboxing
    
    Specified by:
    
    tailMap in interface Int2CharNavigableMap
    
    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 int lowerKey(int e)
```
    Description copied from interface: Int2CharNavigableMap
    
    A Type Specific lowerKey method to reduce boxing/unboxing.
    
    Specified by:
    
    lowerKey in interface Int2CharNavigableMap
    
    Parameters:
    
    e - that should be compared with.
    
    Returns:
    
    the greatest lower key that can be found
  - floorKey
```
public int floorKey(int e)
```
    Description copied from interface: Int2CharNavigableMap
    
    A Type Specific floorKey method to reduce boxing/unboxing.
    
    Specified by:
    
    floorKey in interface Int2CharNavigableMap
    
    Parameters:
    
    e - that should be compared with.
    
    Returns:
    
    the greatest lower or equal key that can be found
  - higherKey
```
public int higherKey(int e)
```
    Description copied from interface: Int2CharNavigableMap
    
    A Type Specific higherKey method to reduce boxing/unboxing.
    
    Specified by:
    
    higherKey in interface Int2CharNavigableMap
    
    Parameters:
    
    e - that should be compared with.
    
    Returns:
    
    the lowest higher key that can be found
  - ceilingKey
```
public int ceilingKey(int e)
```
    Description copied from interface: Int2CharNavigableMap
    
    A Type Specific ceilingKey method to reduce boxing/unboxing.
    
    Specified by:
    
    ceilingKey in interface Int2CharNavigableMap
    
    Parameters:
    
    e - that should be compared with.
    
    Returns:
    
    the lowest higher or equal key that can be found
  - lowerEntry
```
public Int2CharMap.Entry lowerEntry(int key)
```
    Description copied from interface: Int2CharNavigableMap
    
    A Type Specific lowerEntry method to reduce boxing/unboxing.
    
    Specified by:
    
    lowerEntry in interface Int2CharNavigableMap
    
    Parameters:
    
    key - that should be compared with.
    
    Returns:
    
    the greatest lower entry that can be found, or null
  - higherEntry
```
public Int2CharMap.Entry higherEntry(int key)
```
    Description copied from interface: Int2CharNavigableMap
    
    A Type Specific higherEntry method to reduce boxing/unboxing.
    
    Specified by:
    
    higherEntry in interface Int2CharNavigableMap
    
    Parameters:
    
    key - that should be compared with.
    
    Returns:
    
    the lowest higher entry that can be found, or null
  - floorEntry
```
public Int2CharMap.Entry floorEntry(int key)
```
    Description copied from interface: Int2CharNavigableMap
    
    A Type Specific floorEntry method to reduce boxing/unboxing.
    
    Specified by:
    
    floorEntry in interface Int2CharNavigableMap
    
    Parameters:
    
    key - that should be compared with.
    
    Returns:
    
    the greatest lower or equal entry that can be found, or null
  - ceilingEntry
```
public Int2CharMap.Entry ceilingEntry(int key)
```
    Description copied from interface: Int2CharNavigableMap
    
    A Type Specific ceilingEntry method to reduce boxing/unboxing.
    
    Specified by:
    
    ceilingEntry in interface Int2CharNavigableMap
    
    Parameters:
    
    key - that should be compared with.
    
    Returns:
    
    the lowest higher or equal entry that can be found, or null

Class Int2CharRBTreeMap

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.ints.maps.abstracts.AbstractInt2CharMap

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

Nested classes/interfaces inherited from interface speiger.src.collections.ints.maps.interfaces.Int2CharSortedMap

Nested classes/interfaces inherited from interface speiger.src.collections.ints.maps.interfaces.Int2CharMap

Constructor Summary

Method Summary

Methods inherited from class speiger.src.collections.ints.maps.abstracts.AbstractInt2CharMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.ints.maps.interfaces.Int2CharNavigableMap

Methods inherited from interface speiger.src.collections.ints.maps.interfaces.Int2CharSortedMap

Methods inherited from interface speiger.src.collections.ints.maps.interfaces.Int2CharMap

Methods inherited from interface java.util.SortedMap

Methods inherited from interface java.util.Map

Constructor Detail

Int2CharRBTreeMap

Int2CharRBTreeMap

Int2CharRBTreeMap

Int2CharRBTreeMap

Int2CharRBTreeMap

Int2CharRBTreeMap

Int2CharRBTreeMap

Int2CharRBTreeMap

Int2CharRBTreeMap

Int2CharRBTreeMap

Method Detail

setDefaultMaxValue

getDefaultMaxValue

setDefaultMinValue

getDefaultMinValue

put

putIfAbsent

addTo

subFrom

comparator

containsKey

get

getOrDefault

firstIntKey

pollFirstIntKey

lastIntKey

pollLastIntKey

firstEntry

lastEntry

pollFirstEntry

pollLastEntry

firstCharValue

lastCharValue

remove

removeOrDefault

remove

replace

replace

computeChar

computeCharIfAbsent

supplyCharIfAbsent

computeCharIfPresent

mergeChar

mergeAllChar

forEach

size

clear

copy

keySet

int2CharEntrySet

values

navigableKeySet

descendingMap

descendingKeySet

subMap

headMap

tailMap

lowerKey

floorKey

higherKey

ceilingKey

lowerEntry

higherEntry