Char2ShortOpenHashMap (Primitive-Collections 0.2.0 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Character,java.lang.Short>
- - speiger.src.collections.chars.maps.abstracts.AbstractChar2ShortMap
  - - speiger.src.collections.chars.maps.impl.hash.Char2ShortOpenHashMap

All Implemented Interfaces:

java.util.Map<java.lang.Character,java.lang.Short>, Char2ShortFunction, Char2ShortMap

Direct Known Subclasses:

Char2ShortLinkedOpenHashMap
```
public class Char2ShortOpenHashMap
extends AbstractChar2ShortMap
```
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.chars.maps.abstracts.AbstractChar2ShortMap
  AbstractChar2ShortMap.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.chars.maps.interfaces.Char2ShortMap
  Char2ShortMap.Entry, Char2ShortMap.FastEntrySet

Constructor Summary

Constructors
Constructor and Description
`Char2ShortOpenHashMap()` Default Constructor
`Char2ShortOpenHashMap(char[] keys, short[] values)` Helper constructor that allow to create a map from unboxed values
`Char2ShortOpenHashMap(char[] keys, short[] values, float loadFactor)` Helper constructor that allow to create a map from unboxed values
`Char2ShortOpenHashMap(Char2ShortMap map)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`Char2ShortOpenHashMap(Char2ShortMap map, float loadFactor)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`Char2ShortOpenHashMap(java.lang.Character[] keys, java.lang.Short[] values)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`Char2ShortOpenHashMap(java.lang.Character[] keys, java.lang.Short[] values, float loadFactor)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`Char2ShortOpenHashMap(int minCapacity)` Constructor that defines the minimum capacity
`Char2ShortOpenHashMap(int minCapacity, float loadFactor)` Constructor that defines the minimum capacity and load factor
`Char2ShortOpenHashMap(java.util.Map<? extends java.lang.Character,? extends java.lang.Short> map)` A Helper constructor that allows to create a Map with exactly the same values as the provided map.
`Char2ShortOpenHashMap(java.util.Map<? extends java.lang.Character,? extends java.lang.Short> 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
`short`	`addTo(char key, short value)` A Helper method to add a primitives together.
`ObjectSet<Char2ShortMap.Entry>`	`char2ShortEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`void`	`clear()`
`short`	`computeShort(char key, CharShortUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`short`	`computeShortIfAbsent(char key, Char2ShortFunction mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`short`	`computeShortIfPresent(char key, CharShortUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`boolean`	`containsKey(char key)` Type Specific method to reduce boxing/unboxing of values
`boolean`	`containsKey(java.lang.Object key)` Deprecated.
`boolean`	`containsValue(java.lang.Object value)` Deprecated.
`boolean`	`containsValue(short value)` Type Specific method to reduce boxing/unboxing of values
`void`	`forEach(CharShortConsumer action)` Type Specific forEach method to reduce boxing/unboxing
`java.lang.Short`	`get(java.lang.Object key)`
`short`	`getOrDefault(char key, short defaultValue)` A Type Specific getOrDefault method to reduce boxing/unboxing
`short`	`getShort(char key)` A Type Specific get method to reduce boxing/unboxing
`CharSet`	`keySet()`
`void`	`mergeAllShort(Char2ShortMap m, ShortShortUnaryOperator mappingFunction)` A Bulk method for merging Maps.
`short`	`mergeShort(char key, short value, ShortShortUnaryOperator mappingFunction)` A Type Specific merge method to reduce boxing/unboxing
`short`	`put(char key, short value)` Type Specific method to reduce boxing/unboxing of values
`short`	`putIfAbsent(char key, short value)` Type Specific method to reduce boxing/unboxing of values
`short`	`remChar(char key)` Type Specific remove function to reduce boxing/unboxing
`short`	`remCharOrDefault(char key, short defaultValue)` Type-Specific Remove function with a default return value if wanted.
`boolean`	`remove(char key, short value)` Type Specific remove function to reduce boxing/unboxing
`java.lang.Short`	`remove(java.lang.Object key)` Deprecated.
`boolean`	`remove(java.lang.Object key, java.lang.Object value)`
`short`	`replace(char key, short value)` A Type Specific replace method to reduce boxing/unboxing replace an existing value
`boolean`	`replace(char key, short oldValue, short newValue)` A Type Specific replace method to replace an existing value
`int`	`size()`
`ShortCollection`	`values()`

Methods inherited from class speiger.src.collections.chars.maps.abstracts.AbstractChar2ShortMap
addToAll, entrySet, equals, getDefaultReturnValue, getOrDefault, hashCode, putAll, putAll, putAll, putAllIfAbsent, replaceShorts, replaceShorts, 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.chars.maps.interfaces.Char2ShortMap
compute, computeIfAbsent, computeIfPresent, forEach, merge, put, putAll, putIfAbsent, replace, replace, replaceAll

Methods inherited from interface java.util.Map
isEmpty

- Constructor Detail
  - Char2ShortOpenHashMap
```
public Char2ShortOpenHashMap()
```
    Default Constructor
  - Char2ShortOpenHashMap
```
public Char2ShortOpenHashMap(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
  - Char2ShortOpenHashMap
```
public Char2ShortOpenHashMap(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
  - Char2ShortOpenHashMap
```
public Char2ShortOpenHashMap(java.lang.Character[] keys,
                             java.lang.Short[] 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
  - Char2ShortOpenHashMap
```
public Char2ShortOpenHashMap(java.lang.Character[] keys,
                             java.lang.Short[] 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
  - Char2ShortOpenHashMap
```
public Char2ShortOpenHashMap(char[] keys,
                             short[] 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
  - Char2ShortOpenHashMap
```
public Char2ShortOpenHashMap(char[] keys,
                             short[] 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
  - Char2ShortOpenHashMap
```
public Char2ShortOpenHashMap(java.util.Map<? extends java.lang.Character,? extends java.lang.Short> 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
  - Char2ShortOpenHashMap
```
public Char2ShortOpenHashMap(java.util.Map<? extends java.lang.Character,? extends java.lang.Short> 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
  - Char2ShortOpenHashMap
```
public Char2ShortOpenHashMap(Char2ShortMap 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
  - Char2ShortOpenHashMap
```
public Char2ShortOpenHashMap(Char2ShortMap 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 short put(char key,
                 short value)
```
    Description copied from interface: Char2ShortMap
    
    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 short putIfAbsent(char key,
                         short value)
```
    Description copied from interface: Char2ShortMap
    
    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 short addTo(char key,
                   short value)
```
    Description copied from interface: Char2ShortMap
    
    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(char key)
```
    Description copied from interface: Char2ShortMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    containsKey in interface Char2ShortMap
    
    Overrides:
    
    containsKey in class AbstractChar2ShortMap
    
    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.Character,java.lang.Short>
    
    Specified by:
    
    containsKey in interface Char2ShortMap
    
    Overrides:
    
    containsKey in class java.util.AbstractMap<java.lang.Character,java.lang.Short>
    
    Parameters:
    
    key - that is searched for.
    
    Returns:
    
    true if found
    
    See Also:
    
    Map.containsKey(Object)
  - containsValue
```
public boolean containsValue(short value)
```
    Description copied from interface: Char2ShortMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    containsValue in interface Char2ShortMap
    
    Overrides:
    
    containsValue in class AbstractChar2ShortMap
    
    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.Character,java.lang.Short>
    
    Specified by:
    
    containsValue in interface Char2ShortMap
    
    Overrides:
    
    containsValue in class java.util.AbstractMap<java.lang.Character,java.lang.Short>
    
    Parameters:
    
    value - that is searched for.
    
    Returns:
    
    true if found
    
    See Also:
    
    Map.containsValue(Object)
  - remChar
```
public short remChar(char key)
```
    Description copied from interface: Char2ShortMap
    
    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
  - remCharOrDefault
```
public short remCharOrDefault(char key,
                              short defaultValue)
```
    Description copied from interface: Char2ShortMap
    
    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.Short remove(java.lang.Object key)
```
    Deprecated.
    
    Specified by:
    
    remove in interface java.util.Map<java.lang.Character,java.lang.Short>
    
    Specified by:
    
    remove in interface Char2ShortMap
    
    Overrides:
    
    remove in class java.util.AbstractMap<java.lang.Character,java.lang.Short>
    
    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(char key,
                      short value)
```
    Description copied from interface: Char2ShortMap
    
    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)
  - getShort
```
public short getShort(char key)
```
    Description copied from interface: Char2ShortMap
    
    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.Short get(java.lang.Object key)
```
    Specified by:
    
    get in interface java.util.Map<java.lang.Character,java.lang.Short>
    
    Specified by:
    
    get in interface Char2ShortMap
    
    Overrides:
    
    get in class AbstractChar2ShortMap
  - getOrDefault
```
public short getOrDefault(char key,
                          short defaultValue)
```
    Description copied from interface: Char2ShortMap
    
    A Type Specific getOrDefault method to reduce boxing/unboxing
    
    Specified by:
    
    getOrDefault in interface Char2ShortMap
    
    Overrides:
    
    getOrDefault in class AbstractChar2ShortMap
    
    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
  - char2ShortEntrySet
```
public ObjectSet<Char2ShortMap.Entry> char2ShortEntrySet()
```
    Description copied from interface: Char2ShortMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Returns:
    
    a EntrySet of the collection
  - keySet
```
public CharSet keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Character,java.lang.Short>
    
    Specified by:
    
    keySet in interface Char2ShortMap
    
    Overrides:
    
    keySet in class AbstractChar2ShortMap
  - values
```
public ShortCollection values()
```
    Specified by:
    
    values in interface java.util.Map<java.lang.Character,java.lang.Short>
    
    Specified by:
    
    values in interface Char2ShortMap
    
    Overrides:
    
    values in class AbstractChar2ShortMap
  - forEach
```
public void forEach(CharShortConsumer action)
```
    Description copied from interface: Char2ShortMap
    
    Type Specific forEach method to reduce boxing/unboxing
    
    Specified by:
    
    forEach in interface Char2ShortMap
    
    Overrides:
    
    forEach in class AbstractChar2ShortMap
    
    Parameters:
    
    action - processor of the values that are iterator over
  - replace
```
public boolean replace(char key,
                       short oldValue,
                       short newValue)
```
    Description copied from interface: Char2ShortMap
    
    A Type Specific replace method to replace an existing value
    
    Specified by:
    
    replace in interface Char2ShortMap
    
    Overrides:
    
    replace in class AbstractChar2ShortMap
    
    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 short replace(char key,
                     short value)
```
    Description copied from interface: Char2ShortMap
    
    A Type Specific replace method to reduce boxing/unboxing replace an existing value
    
    Specified by:
    
    replace in interface Char2ShortMap
    
    Overrides:
    
    replace in class AbstractChar2ShortMap
    
    Parameters:
    
    key - the element that should be searched for
    
    value - the value to replace with.
    
    Returns:
    
    the present value or default return value
  - computeShort
```
public short computeShort(char key,
                          CharShortUnaryOperator mappingFunction)
```
    Description copied from interface: Char2ShortMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeShort in interface Char2ShortMap
    
    Overrides:
    
    computeShort in class AbstractChar2ShortMap
    
    Parameters:
    
    key - the key that should be computed
    
    mappingFunction - the operator that should generate the value
    
    Returns:
    
    the result of the computation
  - computeShortIfAbsent
```
public short computeShortIfAbsent(char key,
                                  Char2ShortFunction mappingFunction)
```
    Description copied from interface: Char2ShortMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeShortIfAbsent in interface Char2ShortMap
    
    Overrides:
    
    computeShortIfAbsent in class AbstractChar2ShortMap
    
    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
  - computeShortIfPresent
```
public short computeShortIfPresent(char key,
                                   CharShortUnaryOperator mappingFunction)
```
    Description copied from interface: Char2ShortMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeShortIfPresent in interface Char2ShortMap
    
    Overrides:
    
    computeShortIfPresent in class AbstractChar2ShortMap
    
    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
  - mergeShort
```
public short mergeShort(char key,
                        short value,
                        ShortShortUnaryOperator mappingFunction)
```
    Description copied from interface: Char2ShortMap
    
    A Type Specific merge method to reduce boxing/unboxing
    
    Specified by:
    
    mergeShort in interface Char2ShortMap
    
    Overrides:
    
    mergeShort in class AbstractChar2ShortMap
    
    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
  - mergeAllShort
```
public void mergeAllShort(Char2ShortMap m,
                          ShortShortUnaryOperator mappingFunction)
```
    Description copied from interface: Char2ShortMap
    
    A Bulk method for merging Maps.
    
    Specified by:
    
    mergeAllShort in interface Char2ShortMap
    
    Overrides:
    
    mergeAllShort in class AbstractChar2ShortMap
    
    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.Character,java.lang.Short>
    
    Overrides:
    
    size in class java.util.AbstractMap<java.lang.Character,java.lang.Short>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<java.lang.Character,java.lang.Short>
    
    Overrides:
    
    clear in class java.util.AbstractMap<java.lang.Character,java.lang.Short>

Class Char2ShortOpenHashMap

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.chars.maps.abstracts.AbstractChar2ShortMap

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

Nested classes/interfaces inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ShortMap

Constructor Summary

Method Summary

Methods inherited from class speiger.src.collections.chars.maps.abstracts.AbstractChar2ShortMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ShortMap

Methods inherited from interface java.util.Map

Constructor Detail

Char2ShortOpenHashMap

Char2ShortOpenHashMap

Char2ShortOpenHashMap

Char2ShortOpenHashMap

Char2ShortOpenHashMap

Char2ShortOpenHashMap

Char2ShortOpenHashMap

Char2ShortOpenHashMap

Char2ShortOpenHashMap

Char2ShortOpenHashMap

Char2ShortOpenHashMap

Method Detail

put

putIfAbsent

addTo

containsKey

containsKey

containsValue

containsValue

remChar

remCharOrDefault

remove

remove

remove

getShort

get

getOrDefault

char2ShortEntrySet

keySet

values

forEach

replace

replace

computeShort

computeShortIfAbsent

computeShortIfPresent

mergeShort

mergeAllShort

size

clear