ImmutableInt2CharOpenHashMap (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.immutable.ImmutableInt2CharOpenHashMap

All Implemented Interfaces:

java.util.Map<java.lang.Integer,java.lang.Character>, Int2CharFunction, Int2CharMap, Int2CharOrderedMap
```
public class ImmutableInt2CharOpenHashMap
extends AbstractInt2CharMap
implements Int2CharOrderedMap
```
A Type Specific Custom implementation of the HashMap Instead of using Wrapper Object Arrays for storing keys and values there is dedicated arrays for storing keys and values. Extra to that there is a couple quality of life functions provided

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.Int2CharOrderedMap
  Int2CharOrderedMap.FastOrderedSet
- 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
`ImmutableInt2CharOpenHashMap(int[] keys, char[] values)` Helper constructor that allow to create a map from unboxed values
`ImmutableInt2CharOpenHashMap(int[] keys, char[] values, float loadFactor)` Helper constructor that allow to create a map from unboxed values
`ImmutableInt2CharOpenHashMap(Int2CharMap map)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`ImmutableInt2CharOpenHashMap(Int2CharMap map, float loadFactor)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`ImmutableInt2CharOpenHashMap(java.lang.Integer[] keys, java.lang.Character[] values)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`ImmutableInt2CharOpenHashMap(java.lang.Integer[] keys, java.lang.Character[] values, float loadFactor)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`ImmutableInt2CharOpenHashMap(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.
`ImmutableInt2CharOpenHashMap(java.util.Map<? extends java.lang.Integer,? extends java.lang.Character> map, float loadFactor)` A Helper constructor that allows to create a Map with exactly the same values as the provided map.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`char`	`addTo(int key, char value)` A Helper method to add a primitives together.
`void`	`clear()`
`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
`boolean`	`containsKey(java.lang.Object key)` Deprecated.
`boolean`	`containsValue(char value)` Type Specific method to reduce boxing/unboxing of values
`boolean`	`containsValue(java.lang.Object value)` Deprecated.
`ImmutableInt2CharOpenHashMap`	`copy()` A Function that does a shallow clone of the Map itself.
`char`	`firstCharValue()` A method to get the first Value of a Map.
`int`	`firstIntKey()` A method to get the first Key of a Map.
`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
`java.lang.Character`	`get(java.lang.Object key)`
`char`	`getAndMoveToFirst(int key)` A Specific get method that allows to move teh given key/value int the first index.
`char`	`getAndMoveToLast(int key)` A Specific get method that allows to move teh given key/value int the last index.
`char`	`getOrDefault(int key, char defaultValue)` A Type Specific getOrDefault method to reduce boxing/unboxing
`ObjectOrderedSet<Int2CharMap.Entry>`	`int2CharEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`IntOrderedSet`	`keySet()`
`char`	`lastCharValue()` A method to get the last Value of a Map.
`int`	`lastIntKey()` A method to get the last Key of a Map.
`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
`boolean`	`moveToFirst(int key)` A specific move method to move a given key/value to the first index.
`boolean`	`moveToLast(int key)` A specific move method to move a given key/value to the last index.
`int`	`pollFirstIntKey()` A method to get and remove the first Key of a Map.
`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`	`putAndMoveToFirst(int key, char value)` A customized put method that allows you to insert into the first index.
`char`	`putAndMoveToLast(int key, char value)` A customized put method that allows you to insert into the last index.
`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
`java.lang.Character`	`remove(java.lang.Object key)` Deprecated.
`boolean`	`remove(java.lang.Object key, java.lang.Object value)`
`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
`int`	`size()`
`char`	`subFrom(int key, char value)` A Helper method to subtract from primitive from each other.
`char`	`supplyCharIfAbsent(int key, CharSupplier valueProvider)` A Supplier based computeIfAbsent function to fill the most used usecase of this function
`CharCollection`	`values()`

Methods inherited from class speiger.src.collections.ints.maps.abstracts.AbstractInt2CharMap
addToAll, entrySet, equals, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, replaceChars, replaceChars, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap
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.Int2CharOrderedMap
synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.ints.maps.interfaces.Int2CharMap
addToAll, builder, compute, computeIfAbsent, computeIfPresent, entrySet, forEach, getDefaultReturnValue, getOrDefault, merge, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, replace, replace, replaceAll, replaceChars, replaceChars, setDefaultReturnValue

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

- Constructor Detail
  - ImmutableInt2CharOpenHashMap
```
public ImmutableInt2CharOpenHashMap(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
  - ImmutableInt2CharOpenHashMap
```
public ImmutableInt2CharOpenHashMap(java.lang.Integer[] keys,
                                    java.lang.Character[] values,
                                    float loadFactor)
```
    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.
    
    loadFactor - the percentage of how full the backing array can be before they resize
    
    Throws:
    
    java.lang.IllegalStateException - if the keys and values do not match in lenght
    
    java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1
  - ImmutableInt2CharOpenHashMap
```
public ImmutableInt2CharOpenHashMap(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
  - ImmutableInt2CharOpenHashMap
```
public ImmutableInt2CharOpenHashMap(int[] keys,
                                    char[] values,
                                    float loadFactor)
```
    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.
    
    loadFactor - the percentage of how full the backing array can be before they resize
    
    Throws:
    
    java.lang.IllegalStateException - if the keys and values do not match in lenght
    
    java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1
  - ImmutableInt2CharOpenHashMap
```
public ImmutableInt2CharOpenHashMap(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
  - ImmutableInt2CharOpenHashMap
```
public ImmutableInt2CharOpenHashMap(java.util.Map<? extends java.lang.Integer,? extends java.lang.Character> map,
                                    float loadFactor)
```
    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
    
    loadFactor - the percentage of how full the backing array can be before they resize
    
    Throws:
    
    java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1
  - ImmutableInt2CharOpenHashMap
```
public ImmutableInt2CharOpenHashMap(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
  - ImmutableInt2CharOpenHashMap
```
public ImmutableInt2CharOpenHashMap(Int2CharMap map,
                                    float loadFactor)
```
    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
    
    loadFactor - the percentage of how full the backing array can be before they resize
    
    Throws:
    
    java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1
- Method Detail
  - 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
  - putAndMoveToFirst
```
public char putAndMoveToFirst(int key,
                              char value)
```
    Description copied from interface: Int2CharOrderedMap
    
    A customized put method that allows you to insert into the first index.
    
    Specified by:
    
    putAndMoveToFirst in interface Int2CharOrderedMap
    
    Parameters:
    
    key - the key that should be inserted
    
    value - the value that should be inserted
    
    Returns:
    
    the previous present or default return value
    
    See Also:
    
    Map.put(Object, Object)
  - putAndMoveToLast
```
public char putAndMoveToLast(int key,
                             char value)
```
    Description copied from interface: Int2CharOrderedMap
    
    A customized put method that allows you to insert into the last index. (This may be nessesary depending on the implementation)
    
    Specified by:
    
    putAndMoveToLast in interface Int2CharOrderedMap
    
    Parameters:
    
    key - the key that should be inserted
    
    value - the value that should be inserted
    
    Returns:
    
    the previous present or default return value
    
    See Also:
    
    Map.put(Object, Object)
  - moveToFirst
```
public boolean moveToFirst(int key)
```
    Description copied from interface: Int2CharOrderedMap
    
    A specific move method to move a given key/value to the first index.
    
    Specified by:
    
    moveToFirst in interface Int2CharOrderedMap
    
    Parameters:
    
    key - that should be moved to the first index
    
    Returns:
    
    true if the value was moved.
  - moveToLast
```
public boolean moveToLast(int key)
```
    Description copied from interface: Int2CharOrderedMap
    
    A specific move method to move a given key/value to the last index.
    
    Specified by:
    
    moveToLast in interface Int2CharOrderedMap
    
    Parameters:
    
    key - that should be moved to the first last
    
    Returns:
    
    true if the value was moved.
  - getAndMoveToFirst
```
public char getAndMoveToFirst(int key)
```
    Description copied from interface: Int2CharOrderedMap
    
    A Specific get method that allows to move teh given key/value int the first index.
    
    Specified by:
    
    getAndMoveToFirst in interface Int2CharOrderedMap
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - getAndMoveToLast
```
public char getAndMoveToLast(int key)
```
    Description copied from interface: Int2CharOrderedMap
    
    A Specific get method that allows to move teh given key/value int the last index.
    
    Specified by:
    
    getAndMoveToLast in interface Int2CharOrderedMap
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - 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
  - containsKey
```
@Deprecated
public boolean containsKey(java.lang.Object key)
```
    Deprecated.
    
    Specified by:
    
    containsKey in interface java.util.Map<java.lang.Integer,java.lang.Character>
    
    Specified by:
    
    containsKey in interface Int2CharMap
    
    Overrides:
    
    containsKey in class java.util.AbstractMap<java.lang.Integer,java.lang.Character>
    
    Parameters:
    
    key - that is searched for.
    
    Returns:
    
    true if found
    
    See Also:
    
    Map.containsKey(Object)
  - containsValue
```
public boolean containsValue(char value)
```
    Description copied from interface: Int2CharMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    containsValue in interface Int2CharMap
    
    Overrides:
    
    containsValue in class AbstractInt2CharMap
    
    Parameters:
    
    value - element that is searched for
    
    Returns:
    
    if the value is present
  - containsValue
```
@Deprecated
public boolean containsValue(java.lang.Object value)
```
    Deprecated.
    
    Specified by:
    
    containsValue in interface java.util.Map<java.lang.Integer,java.lang.Character>
    
    Specified by:
    
    containsValue in interface Int2CharMap
    
    Overrides:
    
    containsValue in class java.util.AbstractMap<java.lang.Integer,java.lang.Character>
    
    Parameters:
    
    value - that is searched for.
    
    Returns:
    
    true if found
    
    See Also:
    
    Map.containsValue(Object)
  - 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
```
@Deprecated
public java.lang.Character remove(java.lang.Object key)
```
    Deprecated.
    
    Specified by:
    
    remove in interface java.util.Map<java.lang.Integer,java.lang.Character>
    
    Specified by:
    
    remove in interface Int2CharMap
    
    Overrides:
    
    remove in class AbstractInt2CharMap
    
    Parameters:
    
    key - the element that should be removed
    
    Returns:
    
    the value that was removed or default return value
    
    See Also:
    
    Map.remove(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)
  - remove
```
public boolean remove(java.lang.Object key,
                      java.lang.Object value)
```
    Specified by:
    
    remove in interface java.util.Map<java.lang.Integer,java.lang.Character>
    
    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)
  - 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
  - get
```
public java.lang.Character get(java.lang.Object key)
```
    Specified by:
    
    get in interface java.util.Map<java.lang.Integer,java.lang.Character>
    
    Specified by:
    
    get in interface Int2CharMap
    
    Overrides:
    
    get in class AbstractInt2CharMap
  - 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: Int2CharOrderedMap
    
    A method to get the first Key of a Map.
    
    Specified by:
    
    firstIntKey in interface Int2CharOrderedMap
    
    Returns:
    
    the first key in the map
  - pollFirstIntKey
```
public int pollFirstIntKey()
```
    Description copied from interface: Int2CharOrderedMap
    
    A method to get and remove the first Key of a Map.
    
    Specified by:
    
    pollFirstIntKey in interface Int2CharOrderedMap
    
    Returns:
    
    the first key in the map
  - lastIntKey
```
public int lastIntKey()
```
    Description copied from interface: Int2CharOrderedMap
    
    A method to get the last Key of a Map.
    
    Specified by:
    
    lastIntKey in interface Int2CharOrderedMap
    
    Returns:
    
    the last key in the map
  - pollLastIntKey
```
public int pollLastIntKey()
```
    Description copied from interface: Int2CharOrderedMap
    
    A method to get and remove the last Key of a Map.
    
    Specified by:
    
    pollLastIntKey in interface Int2CharOrderedMap
    
    Returns:
    
    the last key in the map
  - firstCharValue
```
public char firstCharValue()
```
    Description copied from interface: Int2CharOrderedMap
    
    A method to get the first Value of a Map.
    
    Specified by:
    
    firstCharValue in interface Int2CharOrderedMap
    
    Returns:
    
    the first key in the map
  - lastCharValue
```
public char lastCharValue()
```
    Description copied from interface: Int2CharOrderedMap
    
    A method to get the last Value of a Map.
    
    Specified by:
    
    lastCharValue in interface Int2CharOrderedMap
    
    Returns:
    
    the last key in the map
  - int2CharEntrySet
```
public ObjectOrderedSet<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
    
    Specified by:
    
    int2CharEntrySet in interface Int2CharOrderedMap
    
    Returns:
    
    a EntrySet of the collection
  - keySet
```
public IntOrderedSet keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Integer,java.lang.Character>
    
    Specified by:
    
    keySet in interface Int2CharMap
    
    Specified by:
    
    keySet in interface Int2CharOrderedMap
    
    Overrides:
    
    keySet in class AbstractInt2CharMap
  - values
```
public CharCollection values()
```
    Specified by:
    
    values in interface java.util.Map<java.lang.Integer,java.lang.Character>
    
    Specified by:
    
    values in interface Int2CharMap
    
    Overrides:
    
    values in class AbstractInt2CharMap
  - copy
```
public ImmutableInt2CharOpenHashMap 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 Int2CharOrderedMap
    
    Overrides:
    
    copy in class AbstractInt2CharMap
    
    Returns:
    
    a Shallow Copy of the Map
  - 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
  - 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
  - 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>

Class ImmutableInt2CharOpenHashMap

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.Int2CharOrderedMap

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.Int2CharOrderedMap

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

Methods inherited from interface java.util.Map

Constructor Detail

ImmutableInt2CharOpenHashMap

ImmutableInt2CharOpenHashMap

ImmutableInt2CharOpenHashMap

ImmutableInt2CharOpenHashMap

ImmutableInt2CharOpenHashMap

ImmutableInt2CharOpenHashMap

ImmutableInt2CharOpenHashMap

ImmutableInt2CharOpenHashMap

Method Detail

put

putIfAbsent

addTo

subFrom

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

containsKey

containsKey

containsValue

containsValue

remove

removeOrDefault

remove

remove

remove

get

get

getOrDefault

firstIntKey

pollFirstIntKey

lastIntKey

pollLastIntKey

firstCharValue

lastCharValue

int2CharEntrySet

keySet

values

copy

forEach

replace

replace

computeChar

computeCharIfAbsent

supplyCharIfAbsent

computeCharIfPresent

mergeChar

mergeAllChar

size

clear