Short2CharRBTreeMap (Primitive-Collections 0.7.0 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Short,java.lang.Character>
- - speiger.src.collections.shorts.maps.abstracts.AbstractShort2CharMap
  - - speiger.src.collections.shorts.maps.impl.tree.Short2CharRBTreeMap

All Implemented Interfaces:

java.util.Map<java.lang.Short,java.lang.Character>, java.util.NavigableMap<java.lang.Short,java.lang.Character>, java.util.SortedMap<java.lang.Short,java.lang.Character>, Short2CharFunction, Short2CharMap, Short2CharNavigableMap, Short2CharSortedMap
```
public class Short2CharRBTreeMap
extends AbstractShort2CharMap
implements Short2CharNavigableMap
```
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.shorts.maps.abstracts.AbstractShort2CharMap
  AbstractShort2CharMap.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.shorts.maps.interfaces.Short2CharSortedMap
  Short2CharSortedMap.FastSortedSet
- Nested classes/interfaces inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2CharMap
  Short2CharMap.BuilderCache, Short2CharMap.Entry, Short2CharMap.FastEntrySet, Short2CharMap.MapBuilder

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`char`	`addTo(short key, char value)` A Helper method to add a primitives together.
`Short2CharMap.Entry`	`ceilingEntry(short key)` A Type Specific ceilingEntry method to reduce boxing/unboxing.
`short`	`ceilingKey(short e)` A Type Specific ceilingKey method to reduce boxing/unboxing.
`void`	`clear()`
`ShortComparator`	`comparator()`
`char`	`computeChar(short key, ShortCharUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`char`	`computeCharIfAbsent(short key, Short2CharFunction mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`char`	`computeCharIfPresent(short key, ShortCharUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`boolean`	`containsKey(short key)` Type Specific method to reduce boxing/unboxing of values
`Short2CharRBTreeMap`	`copy()` A Function that does a shallow clone of the Map itself.
`ShortNavigableSet`	`descendingKeySet()`
`Short2CharNavigableMap`	`descendingMap()`
`char`	`firstCharValue()` A method to get the first Value of a Map.
`Short2CharMap.Entry`	`firstEntry()`
`short`	`firstShortKey()` A method to get the first Key of a Map.
`Short2CharMap.Entry`	`floorEntry(short key)` A Type Specific floorEntry method to reduce boxing/unboxing.
`short`	`floorKey(short e)` A Type Specific floorKey method to reduce boxing/unboxing.
`void`	`forEach(ShortCharConsumer action)` Type Specific forEach method to reduce boxing/unboxing
`char`	`get(short key)` A Type Specific get method to reduce boxing/unboxing
`short`	`getDefaultMaxValue()` A Helper method to get the max value for SubMaps.
`short`	`getDefaultMinValue()` A Helper method to get the min value for SubMaps.
`char`	`getOrDefault(short key, char defaultValue)` A Type Specific getOrDefault method to reduce boxing/unboxing
`Short2CharNavigableMap`	`headMap(short toKey, boolean inclusive)` A Type Specific HeadMap method to reduce boxing/unboxing
`Short2CharMap.Entry`	`higherEntry(short key)` A Type Specific higherEntry method to reduce boxing/unboxing.
`short`	`higherKey(short e)` A Type Specific higherKey method to reduce boxing/unboxing.
`ShortNavigableSet`	`keySet()`
`char`	`lastCharValue()` A method to get the last Value of a Map.
`Short2CharMap.Entry`	`lastEntry()`
`short`	`lastShortKey()` A method to get the last Key of a Map.
`Short2CharMap.Entry`	`lowerEntry(short key)` A Type Specific lowerEntry method to reduce boxing/unboxing.
`short`	`lowerKey(short e)` A Type Specific lowerKey method to reduce boxing/unboxing.
`void`	`mergeAllChar(Short2CharMap m, CharCharUnaryOperator mappingFunction)` A Bulk method for merging Maps.
`char`	`mergeChar(short key, char value, CharCharUnaryOperator mappingFunction)` A Type Specific merge method to reduce boxing/unboxing
`ShortNavigableSet`	`navigableKeySet()`
`Short2CharMap.Entry`	`pollFirstEntry()`
`short`	`pollFirstShortKey()` A method to get and remove the first Key of a Map.
`Short2CharMap.Entry`	`pollLastEntry()`
`short`	`pollLastShortKey()` A method to get and remove the last Key of a Map.
`char`	`put(short key, char value)` Type Specific method to reduce boxing/unboxing of values
`char`	`putIfAbsent(short key, char value)` Type Specific method to reduce boxing/unboxing of values
`char`	`remove(short key)` Type Specific remove function to reduce boxing/unboxing
`boolean`	`remove(short key, char value)` Type Specific remove function to reduce boxing/unboxing
`char`	`removeOrDefault(short key, char defaultValue)` Type-Specific Remove function with a default return value if wanted.
`char`	`replace(short key, char value)` A Type Specific replace method to reduce boxing/unboxing replace an existing value
`boolean`	`replace(short key, char oldValue, char newValue)` A Type Specific replace method to replace an existing value
`void`	`setDefaultMaxValue(short value)` A Helper method to set the max value for SubMaps.
`void`	`setDefaultMinValue(short value)` A Helper method to set the min value for SubMaps.
`ObjectSet<Short2CharMap.Entry>`	`short2CharEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`int`	`size()`
`char`	`subFrom(short key, char value)` A Helper method to subtract from primitive from each other.
`Short2CharNavigableMap`	`subMap(short fromKey, boolean fromInclusive, short toKey, boolean toInclusive)` A Type Specific SubMap method to reduce boxing/unboxing
`char`	`supplyCharIfAbsent(short key, CharSupplier valueProvider)` A Supplier based computeIfAbsent function to fill the most used usecase of this function
`Short2CharNavigableMap`	`tailMap(short fromKey, boolean inclusive)` A Type Specific TailMap method to reduce boxing/unboxing
`CharCollection`	`values()`

Methods inherited from class speiger.src.collections.shorts.maps.abstracts.AbstractShort2CharMap
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.shorts.maps.interfaces.Short2CharNavigableMap
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.shorts.maps.interfaces.Short2CharSortedMap
firstKey, lastKey

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

Class Short2CharRBTreeMap

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.shorts.maps.abstracts.AbstractShort2CharMap

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

Nested classes/interfaces inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2CharSortedMap

Nested classes/interfaces inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2CharMap

Constructor Summary

Method Summary

Methods inherited from class speiger.src.collections.shorts.maps.abstracts.AbstractShort2CharMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2CharNavigableMap

Methods inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2CharSortedMap

Methods inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2CharMap

Methods inherited from interface java.util.SortedMap

Methods inherited from interface java.util.Map

Constructor Detail

Short2CharRBTreeMap

Short2CharRBTreeMap

Short2CharRBTreeMap

Short2CharRBTreeMap

Short2CharRBTreeMap

Short2CharRBTreeMap

Short2CharRBTreeMap

Short2CharRBTreeMap

Short2CharRBTreeMap

Short2CharRBTreeMap

Method Detail

setDefaultMaxValue

getDefaultMaxValue

setDefaultMinValue

getDefaultMinValue

put

putIfAbsent

addTo

subFrom

comparator

containsKey

get

getOrDefault

firstShortKey

pollFirstShortKey

lastShortKey

pollLastShortKey

firstEntry

lastEntry

pollFirstEntry

pollLastEntry

firstCharValue

lastCharValue

remove

removeOrDefault

remove

replace

replace

computeChar

computeCharIfAbsent

supplyCharIfAbsent

computeCharIfPresent

mergeChar

mergeAllChar

forEach

size

clear

copy

keySet

short2CharEntrySet

values

navigableKeySet

descendingMap

descendingKeySet

subMap

headMap

tailMap

lowerKey

floorKey

higherKey

ceilingKey

lowerEntry

higherEntry