Object2CharRBTreeMap (Primitive-Collections 0.8.0 API)

java.lang.Object
- java.util.AbstractMap<T,java.lang.Character>
- - speiger.src.collections.objects.maps.abstracts.AbstractObject2CharMap<T>
  - - speiger.src.collections.objects.maps.impl.tree.Object2CharRBTreeMap<T>

Type Parameters:

T - the keyType of elements maintained by this Collection

All Implemented Interfaces:

java.util.Map<T,java.lang.Character>, java.util.NavigableMap<T,java.lang.Character>, java.util.SortedMap<T,java.lang.Character>, ToCharFunction<T>, Object2CharMap<T>, Object2CharNavigableMap<T>, Object2CharSortedMap<T>
```
public class Object2CharRBTreeMap<T>
extends AbstractObject2CharMap<T>
implements Object2CharNavigableMap<T>
```
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.objects.maps.abstracts.AbstractObject2CharMap
  AbstractObject2CharMap.BasicEntry<T>
- 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.objects.maps.interfaces.Object2CharSortedMap
  Object2CharSortedMap.FastSortedSet<T>
- Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2CharMap
  Object2CharMap.BuilderCache<T>, Object2CharMap.Entry<T>, Object2CharMap.FastEntrySet<T>, Object2CharMap.MapBuilder

Constructor Summary

Constructors
Constructor and Description
`Object2CharRBTreeMap()` Default Constructor
`Object2CharRBTreeMap(java.util.Comparator<T> comp)` Constructor that allows to define the sorter
`Object2CharRBTreeMap(java.util.Map<? extends T,? extends java.lang.Character> map)` A Helper constructor that allows to create a Map with exactly the same values as the provided map.
`Object2CharRBTreeMap(java.util.Map<? extends T,? extends java.lang.Character> map, java.util.Comparator<T> comp)` A Helper constructor that has a custom sorter and allows to create a Map with exactly the same values as the provided map.
`Object2CharRBTreeMap(Object2CharMap<T> map)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`Object2CharRBTreeMap(Object2CharMap<T> map, java.util.Comparator<T> 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.
`Object2CharRBTreeMap(T[] keys, char[] values)` Helper constructor that allow to create a map from unboxed values
`Object2CharRBTreeMap(T[] keys, char[] values, java.util.Comparator<T> comp)` Helper constructor that has a custom sorter and allow to create a map from unboxed values
`Object2CharRBTreeMap(T[] keys, java.lang.Character[] values)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`Object2CharRBTreeMap(T[] keys, java.lang.Character[] values, java.util.Comparator<T> comp)` Helper constructor that has a custom sorter and allow to create a map from boxed values (it will unbox them)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`char`	`addTo(T key, char value)` A Helper method to add a primitives together.
`Object2CharMap.Entry<T>`	`ceilingEntry(T key)`
`T`	`ceilingKey(T e)`
`void`	`clear()`
`java.util.Comparator<T>`	`comparator()`
`char`	`computeChar(T key, ObjectCharUnaryOperator<T> mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`char`	`computeCharIfAbsent(T key, ToCharFunction<T> mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`char`	`computeCharIfPresent(T key, ObjectCharUnaryOperator<T> mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`boolean`	`containsKey(java.lang.Object key)`
`Object2CharRBTreeMap<T>`	`copy()` A Function that does a shallow clone of the Map itself.
`ObjectNavigableSet<T>`	`descendingKeySet()`
`Object2CharNavigableMap<T>`	`descendingMap()`
`char`	`firstCharValue()` A method to get the first Value of a Map.
`Object2CharMap.Entry<T>`	`firstEntry()`
`T`	`firstKey()`
`Object2CharMap.Entry<T>`	`floorEntry(T key)`
`T`	`floorKey(T e)`
`void`	`forEach(ObjectCharConsumer<T> action)` Type Specific forEach method to reduce boxing/unboxing
`char`	`getChar(T key)` A Type Specific get method to reduce boxing/unboxing
`T`	`getDefaultMaxValue()` only used for primitives
`T`	`getDefaultMinValue()` only used for primitives
`char`	`getOrDefault(T key, char defaultValue)` A Type Specific getOrDefault method to reduce boxing/unboxing
`Object2CharNavigableMap<T>`	`headMap(T toKey, boolean inclusive)`
`Object2CharMap.Entry<T>`	`higherEntry(T key)`
`T`	`higherKey(T e)`
`ObjectNavigableSet<T>`	`keySet()`
`char`	`lastCharValue()` A method to get the last Value of a Map.
`Object2CharMap.Entry<T>`	`lastEntry()`
`T`	`lastKey()`
`Object2CharMap.Entry<T>`	`lowerEntry(T key)`
`T`	`lowerKey(T e)`
`void`	`mergeAllChar(Object2CharMap<T> m, CharCharUnaryOperator mappingFunction)` A Bulk method for merging Maps.
`char`	`mergeChar(T key, char value, CharCharUnaryOperator mappingFunction)` A Type Specific merge method to reduce boxing/unboxing
`ObjectNavigableSet<T>`	`navigableKeySet()`
`ObjectSet<Object2CharMap.Entry<T>>`	`object2CharEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`Object2CharMap.Entry<T>`	`pollFirstEntry()`
`T`	`pollFirstKey()` A method to get and remove the first Key of a Map.
`Object2CharMap.Entry<T>`	`pollLastEntry()`
`T`	`pollLastKey()` A method to get and remove the last Key of a Map.
`char`	`put(T key, char value)` Type Specific method to reduce boxing/unboxing of values
`char`	`putIfAbsent(T key, char value)` Type Specific method to reduce boxing/unboxing of values
`char`	`rem(T key)` Type Specific remove function to reduce boxing/unboxing
`char`	`remOrDefault(T key, char defaultValue)` Type-Specific Remove function with a default return value if wanted.
`boolean`	`remove(T key, char value)` Type Specific remove function to reduce boxing/unboxing
`char`	`replace(T key, char value)` A Type Specific replace method to reduce boxing/unboxing replace an existing value
`boolean`	`replace(T key, char oldValue, char newValue)` A Type Specific replace method to replace an existing value
`int`	`size()`
`char`	`subFrom(T key, char value)` A Helper method to subtract from primitive from each other.
`Object2CharNavigableMap<T>`	`subMap(T fromKey, boolean fromInclusive, T toKey, boolean toInclusive)`
`char`	`supplyCharIfAbsent(T key, CharSupplier valueProvider)` A Supplier based computeIfAbsent function to fill the most used usecase of this function
`Object2CharNavigableMap<T>`	`tailMap(T fromKey, boolean inclusive)`
`CharCollection`	`values()`

Methods inherited from class speiger.src.collections.objects.maps.abstracts.AbstractObject2CharMap
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
containsValue, isEmpty, toString

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

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2CharNavigableMap
headMap, subMap, synchronize, synchronize, tailMap, unmodifiable

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2CharMap
addToAll, applyAsChar, builder, compute, computeIfAbsent, computeIfPresent, containsValue, containsValue, entrySet, forEach, get, getDefaultReturnValue, getOrDefault, merge, put, put, 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
  - Object2CharRBTreeMap
```
public Object2CharRBTreeMap()
```
    Default Constructor
  - Object2CharRBTreeMap
```
public Object2CharRBTreeMap(java.util.Comparator<T> comp)
```
    Constructor that allows to define the sorter
    
    Parameters:
    
    comp - the function that decides how the tree is sorted, can be null
  - Object2CharRBTreeMap
```
public Object2CharRBTreeMap(T[] 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
  - Object2CharRBTreeMap
```
public Object2CharRBTreeMap(T[] keys,
                            java.lang.Character[] values,
                            java.util.Comparator<T> 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
  - Object2CharRBTreeMap
```
public Object2CharRBTreeMap(T[] 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
  - Object2CharRBTreeMap
```
public Object2CharRBTreeMap(T[] keys,
                            char[] values,
                            java.util.Comparator<T> 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
  - Object2CharRBTreeMap
```
public Object2CharRBTreeMap(java.util.Map<? extends T,? 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
  - Object2CharRBTreeMap
```
public Object2CharRBTreeMap(java.util.Map<? extends T,? extends java.lang.Character> map,
                            java.util.Comparator<T> 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
  - Object2CharRBTreeMap
```
public Object2CharRBTreeMap(Object2CharMap<T> 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
  - Object2CharRBTreeMap
```
public Object2CharRBTreeMap(Object2CharMap<T> map,
                            java.util.Comparator<T> 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
  - getDefaultMaxValue
```
public T getDefaultMaxValue()
```
    only used for primitives
    
    Returns:
    
    null
  - getDefaultMinValue
```
public T getDefaultMinValue()
```
    only used for primitives
    
    Returns:
    
    null
  - put
```
public char put(T key,
                char value)
```
    Description copied from interface: Object2CharMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    put in interface Object2CharMap<T>
    
    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(T key,
                        char value)
```
    Description copied from interface: Object2CharMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    putIfAbsent in interface Object2CharMap<T>
    
    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(T key,
                  char value)
```
    Description copied from interface: Object2CharMap
    
    A Helper method to add a primitives together. If key is not present then this functions as a put.
    
    Specified by:
    
    addTo in interface Object2CharMap<T>
    
    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(T key,
                    char value)
```
    Description copied from interface: Object2CharMap
    
    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 Object2CharMap.getDefaultReturnValue() If the fence is reached the element will be automaticall removed
    
    Specified by:
    
    subFrom in interface Object2CharMap<T>
    
    Parameters:
    
    key - that should be subtract from
    
    value - that should be subtract
    
    Returns:
    
    the last present or default return value
  - comparator
```
public java.util.Comparator<T> comparator()
```
    Specified by:
    
    comparator in interface java.util.SortedMap<T,java.lang.Character>
    
    Specified by:
    
    comparator in interface Object2CharSortedMap<T>
  - containsKey
```
public boolean containsKey(java.lang.Object key)
```
    Specified by:
    
    containsKey in interface java.util.Map<T,java.lang.Character>
    
    Overrides:
    
    containsKey in class AbstractObject2CharMap<T>
  - getChar
```
public char getChar(T key)
```
    Description copied from interface: Object2CharMap
    
    A Type Specific get method to reduce boxing/unboxing
    
    Specified by:
    
    getChar in interface Object2CharMap<T>
    
    Parameters:
    
    key - the key that is searched for
    
    Returns:
    
    the searched value or default return value
  - getOrDefault
```
public char getOrDefault(T key,
                         char defaultValue)
```
    Description copied from interface: Object2CharMap
    
    A Type Specific getOrDefault method to reduce boxing/unboxing
    
    Specified by:
    
    getOrDefault in interface Object2CharMap<T>
    
    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
  - firstKey
```
public T firstKey()
```
    Specified by:
    
    firstKey in interface java.util.SortedMap<T,java.lang.Character>
  - pollFirstKey
```
public T pollFirstKey()
```
    Description copied from interface: Object2CharSortedMap
    
    A method to get and remove the first Key of a Map.
    
    Specified by:
    
    pollFirstKey in interface Object2CharSortedMap<T>
    
    Returns:
    
    the first key in the map
  - lastKey
```
public T lastKey()
```
    Specified by:
    
    lastKey in interface java.util.SortedMap<T,java.lang.Character>
  - pollLastKey
```
public T pollLastKey()
```
    Description copied from interface: Object2CharSortedMap
    
    A method to get and remove the last Key of a Map.
    
    Specified by:
    
    pollLastKey in interface Object2CharSortedMap<T>
    
    Returns:
    
    the last key in the map
  - firstEntry
```
public Object2CharMap.Entry<T> firstEntry()
```
    Specified by:
    
    firstEntry in interface java.util.NavigableMap<T,java.lang.Character>
    
    Specified by:
    
    firstEntry in interface Object2CharNavigableMap<T>
    
    Returns:
    
    a Type Specific firstEntry
  - lastEntry
```
public Object2CharMap.Entry<T> lastEntry()
```
    Specified by:
    
    lastEntry in interface java.util.NavigableMap<T,java.lang.Character>
    
    Specified by:
    
    lastEntry in interface Object2CharNavigableMap<T>
    
    Returns:
    
    a Type Specific lastEntry
  - pollFirstEntry
```
public Object2CharMap.Entry<T> pollFirstEntry()
```
    Specified by:
    
    pollFirstEntry in interface java.util.NavigableMap<T,java.lang.Character>
    
    Specified by:
    
    pollFirstEntry in interface Object2CharNavigableMap<T>
    
    Returns:
    
    a Type Specific pollFirstEntry
  - pollLastEntry
```
public Object2CharMap.Entry<T> pollLastEntry()
```
    Specified by:
    
    pollLastEntry in interface java.util.NavigableMap<T,java.lang.Character>
    
    Specified by:
    
    pollLastEntry in interface Object2CharNavigableMap<T>
    
    Returns:
    
    a Type Specific pollLastEntry
  - firstCharValue
```
public char firstCharValue()
```
    Description copied from interface: Object2CharSortedMap
    
    A method to get the first Value of a Map.
    
    Specified by:
    
    firstCharValue in interface Object2CharSortedMap<T>
    
    Returns:
    
    the first key in the map
  - lastCharValue
```
public char lastCharValue()
```
    Description copied from interface: Object2CharSortedMap
    
    A method to get the last Value of a Map.
    
    Specified by:
    
    lastCharValue in interface Object2CharSortedMap<T>
    
    Returns:
    
    the last key in the map
  - rem
```
public char rem(T key)
```
    Description copied from interface: Object2CharMap
    
    Type Specific remove function to reduce boxing/unboxing
    
    Specified by:
    
    rem in interface Object2CharMap<T>
    
    Parameters:
    
    key - the element that should be removed
    
    Returns:
    
    the value that was removed or default return value
  - remOrDefault
```
public char remOrDefault(T key,
                         char defaultValue)
```
    Description copied from interface: Object2CharMap
    
    Type-Specific Remove function with a default return value if wanted.
    
    Specified by:
    
    remOrDefault in interface Object2CharMap<T>
    
    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(T key,
                      char value)
```
    Description copied from interface: Object2CharMap
    
    Type Specific remove function to reduce boxing/unboxing
    
    Specified by:
    
    remove in interface Object2CharMap<T>
    
    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(T key,
                       char oldValue,
                       char newValue)
```
    Description copied from interface: Object2CharMap
    
    A Type Specific replace method to replace an existing value
    
    Specified by:
    
    replace in interface Object2CharMap<T>
    
    Overrides:
    
    replace in class AbstractObject2CharMap<T>
    
    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(T key,
                    char value)
```
    Description copied from interface: Object2CharMap
    
    A Type Specific replace method to reduce boxing/unboxing replace an existing value
    
    Specified by:
    
    replace in interface Object2CharMap<T>
    
    Overrides:
    
    replace in class AbstractObject2CharMap<T>
    
    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(T key,
                        ObjectCharUnaryOperator<T> mappingFunction)
```
    Description copied from interface: Object2CharMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeChar in interface Object2CharMap<T>
    
    Overrides:
    
    computeChar in class AbstractObject2CharMap<T>
    
    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(T key,
                                ToCharFunction<T> mappingFunction)
```
    Description copied from interface: Object2CharMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeCharIfAbsent in interface Object2CharMap<T>
    
    Overrides:
    
    computeCharIfAbsent in class AbstractObject2CharMap<T>
    
    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(T key,
                               CharSupplier valueProvider)
```
    Description copied from interface: Object2CharMap
    
    A Supplier based computeIfAbsent function to fill the most used usecase of this function
    
    Specified by:
    
    supplyCharIfAbsent in interface Object2CharMap<T>
    
    Overrides:
    
    supplyCharIfAbsent in class AbstractObject2CharMap<T>
    
    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(T key,
                                 ObjectCharUnaryOperator<T> mappingFunction)
```
    Description copied from interface: Object2CharMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeCharIfPresent in interface Object2CharMap<T>
    
    Overrides:
    
    computeCharIfPresent in class AbstractObject2CharMap<T>
    
    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(T key,
                      char value,
                      CharCharUnaryOperator mappingFunction)
```
    Description copied from interface: Object2CharMap
    
    A Type Specific merge method to reduce boxing/unboxing
    
    Specified by:
    
    mergeChar in interface Object2CharMap<T>
    
    Overrides:
    
    mergeChar in class AbstractObject2CharMap<T>
    
    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(Object2CharMap<T> m,
                         CharCharUnaryOperator mappingFunction)
```
    Description copied from interface: Object2CharMap
    
    A Bulk method for merging Maps.
    
    Specified by:
    
    mergeAllChar in interface Object2CharMap<T>
    
    Overrides:
    
    mergeAllChar in class AbstractObject2CharMap<T>
    
    Parameters:
    
    m - the entries that should be bulk added
    
    mappingFunction - the operator that should generate the new Value
  - forEach
```
public void forEach(ObjectCharConsumer<T> action)
```
    Description copied from interface: Object2CharMap
    
    Type Specific forEach method to reduce boxing/unboxing
    
    Specified by:
    
    forEach in interface Object2CharMap<T>
    
    Overrides:
    
    forEach in class AbstractObject2CharMap<T>
    
    Parameters:
    
    action - processor of the values that are iterator over
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Map<T,java.lang.Character>
    
    Overrides:
    
    size in class java.util.AbstractMap<T,java.lang.Character>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<T,java.lang.Character>
    
    Overrides:
    
    clear in class java.util.AbstractMap<T,java.lang.Character>
  - copy
```
public Object2CharRBTreeMap<T> copy()
```
    Description copied from interface: Object2CharMap
    
    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 Object2CharMap<T>
    
    Specified by:
    
    copy in interface Object2CharNavigableMap<T>
    
    Specified by:
    
    copy in interface Object2CharSortedMap<T>
    
    Overrides:
    
    copy in class AbstractObject2CharMap<T>
    
    Returns:
    
    a Shallow Copy of the Map
  - keySet
```
public ObjectNavigableSet<T> keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<T,java.lang.Character>
    
    Specified by:
    
    keySet in interface java.util.SortedMap<T,java.lang.Character>
    
    Specified by:
    
    keySet in interface Object2CharMap<T>
    
    Specified by:
    
    keySet in interface Object2CharNavigableMap<T>
    
    Specified by:
    
    keySet in interface Object2CharSortedMap<T>
    
    Overrides:
    
    keySet in class AbstractObject2CharMap<T>
    
    Returns:
    
    a Type Specific Navigable Key Set
  - object2CharEntrySet
```
public ObjectSet<Object2CharMap.Entry<T>> object2CharEntrySet()
```
    Description copied from interface: Object2CharMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Specified by:
    
    object2CharEntrySet in interface Object2CharMap<T>
    
    Returns:
    
    a EntrySet of the collection
  - values
```
public CharCollection values()
```
    Specified by:
    
    values in interface java.util.Map<T,java.lang.Character>
    
    Specified by:
    
    values in interface java.util.SortedMap<T,java.lang.Character>
    
    Specified by:
    
    values in interface Object2CharMap<T>
    
    Specified by:
    
    values in interface Object2CharSortedMap<T>
    
    Overrides:
    
    values in class AbstractObject2CharMap<T>
  - navigableKeySet
```
public ObjectNavigableSet<T> navigableKeySet()
```
    Specified by:
    
    navigableKeySet in interface java.util.NavigableMap<T,java.lang.Character>
    
    Specified by:
    
    navigableKeySet in interface Object2CharNavigableMap<T>
    
    Returns:
    
    a Type Specific Navigable Key Set
  - descendingMap
```
public Object2CharNavigableMap<T> descendingMap()
```
    Specified by:
    
    descendingMap in interface java.util.NavigableMap<T,java.lang.Character>
    
    Specified by:
    
    descendingMap in interface Object2CharNavigableMap<T>
    
    Returns:
    
    a Type Specific desendingMap
  - descendingKeySet
```
public ObjectNavigableSet<T> descendingKeySet()
```
    Specified by:
    
    descendingKeySet in interface java.util.NavigableMap<T,java.lang.Character>
    
    Specified by:
    
    descendingKeySet in interface Object2CharNavigableMap<T>
    
    Returns:
    
    a Type Specific Desending Key Set
  - subMap
```
public Object2CharNavigableMap<T> subMap(T fromKey,
                                         boolean fromInclusive,
                                         T toKey,
                                         boolean toInclusive)
```
    Specified by:
    
    subMap in interface java.util.NavigableMap<T,java.lang.Character>
    
    Specified by:
    
    subMap in interface Object2CharNavigableMap<T>
  - headMap
```
public Object2CharNavigableMap<T> headMap(T toKey,
                                          boolean inclusive)
```
    Specified by:
    
    headMap in interface java.util.NavigableMap<T,java.lang.Character>
    
    Specified by:
    
    headMap in interface Object2CharNavigableMap<T>
  - tailMap
```
public Object2CharNavigableMap<T> tailMap(T fromKey,
                                          boolean inclusive)
```
    Specified by:
    
    tailMap in interface java.util.NavigableMap<T,java.lang.Character>
    
    Specified by:
    
    tailMap in interface Object2CharNavigableMap<T>
  - lowerKey
```
public T lowerKey(T e)
```
    Specified by:
    
    lowerKey in interface java.util.NavigableMap<T,java.lang.Character>
  - floorKey
```
public T floorKey(T e)
```
    Specified by:
    
    floorKey in interface java.util.NavigableMap<T,java.lang.Character>
  - higherKey
```
public T higherKey(T e)
```
    Specified by:
    
    higherKey in interface java.util.NavigableMap<T,java.lang.Character>
  - ceilingKey
```
public T ceilingKey(T e)
```
    Specified by:
    
    ceilingKey in interface java.util.NavigableMap<T,java.lang.Character>
  - lowerEntry
```
public Object2CharMap.Entry<T> lowerEntry(T key)
```
    Specified by:
    
    lowerEntry in interface java.util.NavigableMap<T,java.lang.Character>
    
    Specified by:
    
    lowerEntry in interface Object2CharNavigableMap<T>
  - higherEntry
```
public Object2CharMap.Entry<T> higherEntry(T key)
```
    Specified by:
    
    higherEntry in interface java.util.NavigableMap<T,java.lang.Character>
    
    Specified by:
    
    higherEntry in interface Object2CharNavigableMap<T>
  - floorEntry
```
public Object2CharMap.Entry<T> floorEntry(T key)
```
    Specified by:
    
    floorEntry in interface java.util.NavigableMap<T,java.lang.Character>
    
    Specified by:
    
    floorEntry in interface Object2CharNavigableMap<T>
  - ceilingEntry
```
public Object2CharMap.Entry<T> ceilingEntry(T key)
```
    Specified by:
    
    ceilingEntry in interface java.util.NavigableMap<T,java.lang.Character>
    
    Specified by:
    
    ceilingEntry in interface Object2CharNavigableMap<T>

Class Object2CharRBTreeMap<T>

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.objects.maps.abstracts.AbstractObject2CharMap

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

Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2CharSortedMap

Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2CharMap

Constructor Summary

Method Summary

Methods inherited from class speiger.src.collections.objects.maps.abstracts.AbstractObject2CharMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2CharNavigableMap

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2CharMap

Methods inherited from interface java.util.SortedMap

Methods inherited from interface java.util.Map

Constructor Detail

Object2CharRBTreeMap

Object2CharRBTreeMap

Object2CharRBTreeMap

Object2CharRBTreeMap

Object2CharRBTreeMap

Object2CharRBTreeMap

Object2CharRBTreeMap

Object2CharRBTreeMap

Object2CharRBTreeMap

Object2CharRBTreeMap

Method Detail

getDefaultMaxValue

getDefaultMinValue

put

putIfAbsent

addTo

subFrom

comparator

containsKey

getChar

getOrDefault

firstKey

pollFirstKey

lastKey

pollLastKey

firstEntry

lastEntry

pollFirstEntry

pollLastEntry

firstCharValue

lastCharValue

rem

remOrDefault

remove

replace

replace

computeChar

computeCharIfAbsent

supplyCharIfAbsent

computeCharIfPresent

mergeChar

mergeAllChar

forEach

size

clear

copy

keySet

object2CharEntrySet

values

navigableKeySet

descendingMap

descendingKeySet

subMap

headMap

tailMap

lowerKey

floorKey

higherKey

ceilingKey

lowerEntry

higherEntry

floorEntry

ceilingEntry