Long2CharOpenHashMap (Primitive-Collections 0.2.0 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Long,java.lang.Character>
- - speiger.src.collections.longs.maps.abstracts.AbstractLong2CharMap
  - - speiger.src.collections.longs.maps.impl.hash.Long2CharOpenHashMap

All Implemented Interfaces:

java.util.Map<java.lang.Long,java.lang.Character>, Long2CharFunction, Long2CharMap

Direct Known Subclasses:

Long2CharLinkedOpenHashMap
```
public class Long2CharOpenHashMap
extends AbstractLong2CharMap
```
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.longs.maps.abstracts.AbstractLong2CharMap
  AbstractLong2CharMap.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.longs.maps.interfaces.Long2CharMap
  Long2CharMap.Entry, Long2CharMap.FastEntrySet

Constructor Summary

Constructors
Constructor and Description
`Long2CharOpenHashMap()` Default Constructor
`Long2CharOpenHashMap(int minCapacity)` Constructor that defines the minimum capacity
`Long2CharOpenHashMap(int minCapacity, float loadFactor)` Constructor that defines the minimum capacity and load factor
`Long2CharOpenHashMap(long[] keys, char[] values)` Helper constructor that allow to create a map from unboxed values
`Long2CharOpenHashMap(long[] keys, char[] values, float loadFactor)` Helper constructor that allow to create a map from unboxed values
`Long2CharOpenHashMap(java.lang.Long[] keys, java.lang.Character[] values)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`Long2CharOpenHashMap(java.lang.Long[] keys, java.lang.Character[] values, float loadFactor)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`Long2CharOpenHashMap(Long2CharMap map)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`Long2CharOpenHashMap(Long2CharMap map, float loadFactor)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`Long2CharOpenHashMap(java.util.Map<? extends java.lang.Long,? extends java.lang.Character> map)` A Helper constructor that allows to create a Map with exactly the same values as the provided map.
`Long2CharOpenHashMap(java.util.Map<? extends java.lang.Long,? 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(long key, char value)` A Helper method to add a primitives together.
`void`	`clear()`
`char`	`computeChar(long key, LongCharUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`char`	`computeCharIfAbsent(long key, Long2CharFunction mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`char`	`computeCharIfPresent(long key, LongCharUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`boolean`	`containsKey(long 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.
`void`	`forEach(LongCharConsumer action)` Type Specific forEach method to reduce boxing/unboxing
`java.lang.Character`	`get(java.lang.Object key)`
`char`	`getChar(long key)` A Type Specific get method to reduce boxing/unboxing
`char`	`getOrDefault(long key, char defaultValue)` A Type Specific getOrDefault method to reduce boxing/unboxing
`LongSet`	`keySet()`
`ObjectSet<Long2CharMap.Entry>`	`long2CharEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`void`	`mergeAllChar(Long2CharMap m, CharCharUnaryOperator mappingFunction)` A Bulk method for merging Maps.
`char`	`mergeChar(long key, char value, CharCharUnaryOperator mappingFunction)` A Type Specific merge method to reduce boxing/unboxing
`char`	`put(long key, char value)` Type Specific method to reduce boxing/unboxing of values
`char`	`putIfAbsent(long key, char value)` Type Specific method to reduce boxing/unboxing of values
`char`	`remLong(long key)` Type Specific remove function to reduce boxing/unboxing
`char`	`remLongOrDefault(long key, char defaultValue)` Type-Specific Remove function with a default return value if wanted.
`boolean`	`remove(long 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`	`replace(long key, char value)` A Type Specific replace method to reduce boxing/unboxing replace an existing value
`boolean`	`replace(long key, char oldValue, char newValue)` A Type Specific replace method to replace an existing value
`int`	`size()`
`CharCollection`	`values()`

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

Methods inherited from class java.util.AbstractMap
isEmpty, put, toString

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

Methods inherited from interface speiger.src.collections.longs.maps.interfaces.Long2CharMap
compute, computeIfAbsent, computeIfPresent, forEach, merge, put, putAll, putIfAbsent, replace, replace, replaceAll

Methods inherited from interface java.util.Map
isEmpty

- Constructor Detail
  - Long2CharOpenHashMap
```
public Long2CharOpenHashMap()
```
    Default Constructor
  - Long2CharOpenHashMap
```
public Long2CharOpenHashMap(int minCapacity)
```
    Constructor that defines the minimum capacity
    
    Parameters:
    
    minCapacity - the minimum capacity the HashMap is allowed to be.
    
    Throws:
    
    java.lang.IllegalStateException - if the minimum capacity is negative
  - Long2CharOpenHashMap
```
public Long2CharOpenHashMap(int minCapacity,
                            float loadFactor)
```
    Constructor that defines the minimum capacity and load factor
    
    Parameters:
    
    minCapacity - the minimum capacity the HashMap is allowed to be.
    
    loadFactor - the percentage of how full the backing array can be before they resize
    
    Throws:
    
    java.lang.IllegalStateException - if the minimum capacity is negative
    
    java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1
  - Long2CharOpenHashMap
```
public Long2CharOpenHashMap(java.lang.Long[] 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
  - Long2CharOpenHashMap
```
public Long2CharOpenHashMap(java.lang.Long[] 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
  - Long2CharOpenHashMap
```
public Long2CharOpenHashMap(long[] 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
  - Long2CharOpenHashMap
```
public Long2CharOpenHashMap(long[] 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
  - Long2CharOpenHashMap
```
public Long2CharOpenHashMap(java.util.Map<? extends java.lang.Long,? 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
  - Long2CharOpenHashMap
```
public Long2CharOpenHashMap(java.util.Map<? extends java.lang.Long,? 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
  - Long2CharOpenHashMap
```
public Long2CharOpenHashMap(Long2CharMap 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
  - Long2CharOpenHashMap
```
public Long2CharOpenHashMap(Long2CharMap 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(long key,
                char value)
```
    Description copied from interface: Long2CharMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    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(long key,
                        char value)
```
    Description copied from interface: Long2CharMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    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(long key,
                  char value)
```
    Description copied from interface: Long2CharMap
    
    A Helper method to add a primitives together. If key is not present then this functions as a put.
    
    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.
  - containsKey
```
public boolean containsKey(long key)
```
    Description copied from interface: Long2CharMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    containsKey in interface Long2CharMap
    
    Overrides:
    
    containsKey in class AbstractLong2CharMap
    
    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.Long,java.lang.Character>
    
    Specified by:
    
    containsKey in interface Long2CharMap
    
    Overrides:
    
    containsKey in class java.util.AbstractMap<java.lang.Long,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: Long2CharMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    containsValue in interface Long2CharMap
    
    Overrides:
    
    containsValue in class AbstractLong2CharMap
    
    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.Long,java.lang.Character>
    
    Specified by:
    
    containsValue in interface Long2CharMap
    
    Overrides:
    
    containsValue in class java.util.AbstractMap<java.lang.Long,java.lang.Character>
    
    Parameters:
    
    value - that is searched for.
    
    Returns:
    
    true if found
    
    See Also:
    
    Map.containsValue(Object)
  - remLong
```
public char remLong(long key)
```
    Description copied from interface: Long2CharMap
    
    Type Specific remove function to reduce boxing/unboxing
    
    Parameters:
    
    key - the element that should be removed
    
    Returns:
    
    the value that was removed or default return value
  - remLongOrDefault
```
public char remLongOrDefault(long key,
                             char defaultValue)
```
    Description copied from interface: Long2CharMap
    
    Type-Specific Remove function with a default return value if wanted.
    
    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.Long,java.lang.Character>
    
    Specified by:
    
    remove in interface Long2CharMap
    
    Overrides:
    
    remove in class java.util.AbstractMap<java.lang.Long,java.lang.Character>
    
    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(long key,
                      char value)
```
    Description copied from interface: Long2CharMap
    
    Type Specific remove function to reduce boxing/unboxing
    
    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)
```
    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)
  - getChar
```
public char getChar(long key)
```
    Description copied from interface: Long2CharMap
    
    A Type Specific get method to reduce boxing/unboxing
    
    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.Long,java.lang.Character>
    
    Specified by:
    
    get in interface Long2CharMap
    
    Overrides:
    
    get in class AbstractLong2CharMap
  - getOrDefault
```
public char getOrDefault(long key,
                         char defaultValue)
```
    Description copied from interface: Long2CharMap
    
    A Type Specific getOrDefault method to reduce boxing/unboxing
    
    Specified by:
    
    getOrDefault in interface Long2CharMap
    
    Overrides:
    
    getOrDefault in class AbstractLong2CharMap
    
    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
  - long2CharEntrySet
```
public ObjectSet<Long2CharMap.Entry> long2CharEntrySet()
```
    Description copied from interface: Long2CharMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Returns:
    
    a EntrySet of the collection
  - keySet
```
public LongSet keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Long,java.lang.Character>
    
    Specified by:
    
    keySet in interface Long2CharMap
    
    Overrides:
    
    keySet in class AbstractLong2CharMap
  - values
```
public CharCollection values()
```
    Specified by:
    
    values in interface java.util.Map<java.lang.Long,java.lang.Character>
    
    Specified by:
    
    values in interface Long2CharMap
    
    Overrides:
    
    values in class AbstractLong2CharMap
  - forEach
```
public void forEach(LongCharConsumer action)
```
    Description copied from interface: Long2CharMap
    
    Type Specific forEach method to reduce boxing/unboxing
    
    Specified by:
    
    forEach in interface Long2CharMap
    
    Overrides:
    
    forEach in class AbstractLong2CharMap
    
    Parameters:
    
    action - processor of the values that are iterator over
  - replace
```
public boolean replace(long key,
                       char oldValue,
                       char newValue)
```
    Description copied from interface: Long2CharMap
    
    A Type Specific replace method to replace an existing value
    
    Specified by:
    
    replace in interface Long2CharMap
    
    Overrides:
    
    replace in class AbstractLong2CharMap
    
    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(long key,
                    char value)
```
    Description copied from interface: Long2CharMap
    
    A Type Specific replace method to reduce boxing/unboxing replace an existing value
    
    Specified by:
    
    replace in interface Long2CharMap
    
    Overrides:
    
    replace in class AbstractLong2CharMap
    
    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(long key,
                        LongCharUnaryOperator mappingFunction)
```
    Description copied from interface: Long2CharMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeChar in interface Long2CharMap
    
    Overrides:
    
    computeChar in class AbstractLong2CharMap
    
    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(long key,
                                Long2CharFunction mappingFunction)
```
    Description copied from interface: Long2CharMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeCharIfAbsent in interface Long2CharMap
    
    Overrides:
    
    computeCharIfAbsent in class AbstractLong2CharMap
    
    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
  - computeCharIfPresent
```
public char computeCharIfPresent(long key,
                                 LongCharUnaryOperator mappingFunction)
```
    Description copied from interface: Long2CharMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeCharIfPresent in interface Long2CharMap
    
    Overrides:
    
    computeCharIfPresent in class AbstractLong2CharMap
    
    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(long key,
                      char value,
                      CharCharUnaryOperator mappingFunction)
```
    Description copied from interface: Long2CharMap
    
    A Type Specific merge method to reduce boxing/unboxing
    
    Specified by:
    
    mergeChar in interface Long2CharMap
    
    Overrides:
    
    mergeChar in class AbstractLong2CharMap
    
    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(Long2CharMap m,
                         CharCharUnaryOperator mappingFunction)
```
    Description copied from interface: Long2CharMap
    
    A Bulk method for merging Maps.
    
    Specified by:
    
    mergeAllChar in interface Long2CharMap
    
    Overrides:
    
    mergeAllChar in class AbstractLong2CharMap
    
    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.Long,java.lang.Character>
    
    Overrides:
    
    size in class java.util.AbstractMap<java.lang.Long,java.lang.Character>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<java.lang.Long,java.lang.Character>
    
    Overrides:
    
    clear in class java.util.AbstractMap<java.lang.Long,java.lang.Character>

Class Long2CharOpenHashMap

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.longs.maps.abstracts.AbstractLong2CharMap

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

Nested classes/interfaces inherited from interface speiger.src.collections.longs.maps.interfaces.Long2CharMap

Constructor Summary

Method Summary

Methods inherited from class speiger.src.collections.longs.maps.abstracts.AbstractLong2CharMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.longs.maps.interfaces.Long2CharMap

Methods inherited from interface java.util.Map

Constructor Detail

Long2CharOpenHashMap

Long2CharOpenHashMap

Long2CharOpenHashMap

Long2CharOpenHashMap

Long2CharOpenHashMap

Long2CharOpenHashMap

Long2CharOpenHashMap

Long2CharOpenHashMap

Long2CharOpenHashMap

Long2CharOpenHashMap

Long2CharOpenHashMap

Method Detail

put

putIfAbsent

addTo

containsKey

containsKey

containsValue

containsValue

remLong

remLongOrDefault

remove

remove

remove

getChar

get

getOrDefault

long2CharEntrySet

keySet

values

forEach

replace

replace

computeChar

computeCharIfAbsent

computeCharIfPresent

mergeChar

mergeAllChar

size

clear