Byte2LongOpenHashMap (Primitive-Collections 0.2.0 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Byte,java.lang.Long>
- - speiger.src.collections.bytes.maps.abstracts.AbstractByte2LongMap
  - - speiger.src.collections.bytes.maps.impl.hash.Byte2LongOpenHashMap

All Implemented Interfaces:

java.util.Map<java.lang.Byte,java.lang.Long>, Byte2LongFunction, Byte2LongMap

Direct Known Subclasses:

Byte2LongLinkedOpenHashMap
```
public class Byte2LongOpenHashMap
extends AbstractByte2LongMap
```
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.bytes.maps.abstracts.AbstractByte2LongMap
  AbstractByte2LongMap.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.bytes.maps.interfaces.Byte2LongMap
  Byte2LongMap.Entry, Byte2LongMap.FastEntrySet

Constructor Summary

Constructors
Constructor and Description
`Byte2LongOpenHashMap()` Default Constructor
`Byte2LongOpenHashMap(byte[] keys, long[] values)` Helper constructor that allow to create a map from unboxed values
`Byte2LongOpenHashMap(java.lang.Byte[] keys, java.lang.Long[] values)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`Byte2LongOpenHashMap(byte[] keys, long[] values, float loadFactor)` Helper constructor that allow to create a map from unboxed values
`Byte2LongOpenHashMap(java.lang.Byte[] keys, java.lang.Long[] values, float loadFactor)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`Byte2LongOpenHashMap(Byte2LongMap map)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`Byte2LongOpenHashMap(Byte2LongMap map, float loadFactor)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`Byte2LongOpenHashMap(int minCapacity)` Constructor that defines the minimum capacity
`Byte2LongOpenHashMap(int minCapacity, float loadFactor)` Constructor that defines the minimum capacity and load factor
`Byte2LongOpenHashMap(java.util.Map<? extends java.lang.Byte,? extends java.lang.Long> map)` A Helper constructor that allows to create a Map with exactly the same values as the provided map.
`Byte2LongOpenHashMap(java.util.Map<? extends java.lang.Byte,? extends java.lang.Long> 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
`long`	`addTo(byte key, long value)` A Helper method to add a primitives together.
`ObjectSet<Byte2LongMap.Entry>`	`byte2LongEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`void`	`clear()`
`long`	`computeLong(byte key, ByteLongUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`long`	`computeLongIfAbsent(byte key, Byte2LongFunction mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`long`	`computeLongIfPresent(byte key, ByteLongUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`boolean`	`containsKey(byte key)` Type Specific method to reduce boxing/unboxing of values
`boolean`	`containsKey(java.lang.Object key)` Deprecated.
`boolean`	`containsValue(long value)` Type Specific method to reduce boxing/unboxing of values
`boolean`	`containsValue(java.lang.Object value)` Deprecated.
`void`	`forEach(ByteLongConsumer action)` Type Specific forEach method to reduce boxing/unboxing
`java.lang.Long`	`get(java.lang.Object key)`
`long`	`getLong(byte key)` A Type Specific get method to reduce boxing/unboxing
`long`	`getOrDefault(byte key, long defaultValue)` A Type Specific getOrDefault method to reduce boxing/unboxing
`ByteSet`	`keySet()`
`void`	`mergeAllLong(Byte2LongMap m, LongLongUnaryOperator mappingFunction)` A Bulk method for merging Maps.
`long`	`mergeLong(byte key, long value, LongLongUnaryOperator mappingFunction)` A Type Specific merge method to reduce boxing/unboxing
`long`	`put(byte key, long value)` Type Specific method to reduce boxing/unboxing of values
`long`	`putIfAbsent(byte key, long value)` Type Specific method to reduce boxing/unboxing of values
`long`	`remByte(byte key)` Type Specific remove function to reduce boxing/unboxing
`long`	`remByteOrDefault(byte key, long defaultValue)` Type-Specific Remove function with a default return value if wanted.
`boolean`	`remove(byte key, long value)` Type Specific remove function to reduce boxing/unboxing
`java.lang.Long`	`remove(java.lang.Object key)` Deprecated.
`boolean`	`remove(java.lang.Object key, java.lang.Object value)`
`long`	`replace(byte key, long value)` A Type Specific replace method to reduce boxing/unboxing replace an existing value
`boolean`	`replace(byte key, long oldValue, long newValue)` A Type Specific replace method to replace an existing value
`int`	`size()`
`LongCollection`	`values()`

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

Methods inherited from interface java.util.Map
isEmpty

- Constructor Detail
  - Byte2LongOpenHashMap
```
public Byte2LongOpenHashMap()
```
    Default Constructor
  - Byte2LongOpenHashMap
```
public Byte2LongOpenHashMap(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
  - Byte2LongOpenHashMap
```
public Byte2LongOpenHashMap(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
  - Byte2LongOpenHashMap
```
public Byte2LongOpenHashMap(java.lang.Byte[] keys,
                            java.lang.Long[] 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
  - Byte2LongOpenHashMap
```
public Byte2LongOpenHashMap(java.lang.Byte[] keys,
                            java.lang.Long[] 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
  - Byte2LongOpenHashMap
```
public Byte2LongOpenHashMap(byte[] keys,
                            long[] 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
  - Byte2LongOpenHashMap
```
public Byte2LongOpenHashMap(byte[] keys,
                            long[] 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
  - Byte2LongOpenHashMap
```
public Byte2LongOpenHashMap(java.util.Map<? extends java.lang.Byte,? extends java.lang.Long> 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
  - Byte2LongOpenHashMap
```
public Byte2LongOpenHashMap(java.util.Map<? extends java.lang.Byte,? extends java.lang.Long> 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
  - Byte2LongOpenHashMap
```
public Byte2LongOpenHashMap(Byte2LongMap 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
  - Byte2LongOpenHashMap
```
public Byte2LongOpenHashMap(Byte2LongMap 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 long put(byte key,
                long value)
```
    Description copied from interface: Byte2LongMap
    
    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 long putIfAbsent(byte key,
                        long value)
```
    Description copied from interface: Byte2LongMap
    
    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 long addTo(byte key,
                  long value)
```
    Description copied from interface: Byte2LongMap
    
    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(byte key)
```
    Description copied from interface: Byte2LongMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    containsKey in interface Byte2LongMap
    
    Overrides:
    
    containsKey in class AbstractByte2LongMap
    
    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.Byte,java.lang.Long>
    
    Specified by:
    
    containsKey in interface Byte2LongMap
    
    Overrides:
    
    containsKey in class java.util.AbstractMap<java.lang.Byte,java.lang.Long>
    
    Parameters:
    
    key - that is searched for.
    
    Returns:
    
    true if found
    
    See Also:
    
    Map.containsKey(Object)
  - containsValue
```
public boolean containsValue(long value)
```
    Description copied from interface: Byte2LongMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    containsValue in interface Byte2LongMap
    
    Overrides:
    
    containsValue in class AbstractByte2LongMap
    
    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.Byte,java.lang.Long>
    
    Specified by:
    
    containsValue in interface Byte2LongMap
    
    Overrides:
    
    containsValue in class java.util.AbstractMap<java.lang.Byte,java.lang.Long>
    
    Parameters:
    
    value - that is searched for.
    
    Returns:
    
    true if found
    
    See Also:
    
    Map.containsValue(Object)
  - remByte
```
public long remByte(byte key)
```
    Description copied from interface: Byte2LongMap
    
    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
  - remByteOrDefault
```
public long remByteOrDefault(byte key,
                             long defaultValue)
```
    Description copied from interface: Byte2LongMap
    
    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.Long remove(java.lang.Object key)
```
    Deprecated.
    
    Specified by:
    
    remove in interface java.util.Map<java.lang.Byte,java.lang.Long>
    
    Specified by:
    
    remove in interface Byte2LongMap
    
    Overrides:
    
    remove in class java.util.AbstractMap<java.lang.Byte,java.lang.Long>
    
    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(byte key,
                      long value)
```
    Description copied from interface: Byte2LongMap
    
    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)
  - getLong
```
public long getLong(byte key)
```
    Description copied from interface: Byte2LongMap
    
    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.Long get(java.lang.Object key)
```
    Specified by:
    
    get in interface java.util.Map<java.lang.Byte,java.lang.Long>
    
    Specified by:
    
    get in interface Byte2LongMap
    
    Overrides:
    
    get in class AbstractByte2LongMap
  - getOrDefault
```
public long getOrDefault(byte key,
                         long defaultValue)
```
    Description copied from interface: Byte2LongMap
    
    A Type Specific getOrDefault method to reduce boxing/unboxing
    
    Specified by:
    
    getOrDefault in interface Byte2LongMap
    
    Overrides:
    
    getOrDefault in class AbstractByte2LongMap
    
    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
  - byte2LongEntrySet
```
public ObjectSet<Byte2LongMap.Entry> byte2LongEntrySet()
```
    Description copied from interface: Byte2LongMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Returns:
    
    a EntrySet of the collection
  - keySet
```
public ByteSet keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Byte,java.lang.Long>
    
    Specified by:
    
    keySet in interface Byte2LongMap
    
    Overrides:
    
    keySet in class AbstractByte2LongMap
  - values
```
public LongCollection values()
```
    Specified by:
    
    values in interface java.util.Map<java.lang.Byte,java.lang.Long>
    
    Specified by:
    
    values in interface Byte2LongMap
    
    Overrides:
    
    values in class AbstractByte2LongMap
  - forEach
```
public void forEach(ByteLongConsumer action)
```
    Description copied from interface: Byte2LongMap
    
    Type Specific forEach method to reduce boxing/unboxing
    
    Specified by:
    
    forEach in interface Byte2LongMap
    
    Overrides:
    
    forEach in class AbstractByte2LongMap
    
    Parameters:
    
    action - processor of the values that are iterator over
  - replace
```
public boolean replace(byte key,
                       long oldValue,
                       long newValue)
```
    Description copied from interface: Byte2LongMap
    
    A Type Specific replace method to replace an existing value
    
    Specified by:
    
    replace in interface Byte2LongMap
    
    Overrides:
    
    replace in class AbstractByte2LongMap
    
    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 long replace(byte key,
                    long value)
```
    Description copied from interface: Byte2LongMap
    
    A Type Specific replace method to reduce boxing/unboxing replace an existing value
    
    Specified by:
    
    replace in interface Byte2LongMap
    
    Overrides:
    
    replace in class AbstractByte2LongMap
    
    Parameters:
    
    key - the element that should be searched for
    
    value - the value to replace with.
    
    Returns:
    
    the present value or default return value
  - computeLong
```
public long computeLong(byte key,
                        ByteLongUnaryOperator mappingFunction)
```
    Description copied from interface: Byte2LongMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeLong in interface Byte2LongMap
    
    Overrides:
    
    computeLong in class AbstractByte2LongMap
    
    Parameters:
    
    key - the key that should be computed
    
    mappingFunction - the operator that should generate the value
    
    Returns:
    
    the result of the computation
  - computeLongIfAbsent
```
public long computeLongIfAbsent(byte key,
                                Byte2LongFunction mappingFunction)
```
    Description copied from interface: Byte2LongMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeLongIfAbsent in interface Byte2LongMap
    
    Overrides:
    
    computeLongIfAbsent in class AbstractByte2LongMap
    
    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
  - computeLongIfPresent
```
public long computeLongIfPresent(byte key,
                                 ByteLongUnaryOperator mappingFunction)
```
    Description copied from interface: Byte2LongMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeLongIfPresent in interface Byte2LongMap
    
    Overrides:
    
    computeLongIfPresent in class AbstractByte2LongMap
    
    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
  - mergeLong
```
public long mergeLong(byte key,
                      long value,
                      LongLongUnaryOperator mappingFunction)
```
    Description copied from interface: Byte2LongMap
    
    A Type Specific merge method to reduce boxing/unboxing
    
    Specified by:
    
    mergeLong in interface Byte2LongMap
    
    Overrides:
    
    mergeLong in class AbstractByte2LongMap
    
    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
  - mergeAllLong
```
public void mergeAllLong(Byte2LongMap m,
                         LongLongUnaryOperator mappingFunction)
```
    Description copied from interface: Byte2LongMap
    
    A Bulk method for merging Maps.
    
    Specified by:
    
    mergeAllLong in interface Byte2LongMap
    
    Overrides:
    
    mergeAllLong in class AbstractByte2LongMap
    
    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.Byte,java.lang.Long>
    
    Overrides:
    
    size in class java.util.AbstractMap<java.lang.Byte,java.lang.Long>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<java.lang.Byte,java.lang.Long>
    
    Overrides:
    
    clear in class java.util.AbstractMap<java.lang.Byte,java.lang.Long>

Class Byte2LongOpenHashMap

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.bytes.maps.abstracts.AbstractByte2LongMap

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

Nested classes/interfaces inherited from interface speiger.src.collections.bytes.maps.interfaces.Byte2LongMap

Constructor Summary

Method Summary

Methods inherited from class speiger.src.collections.bytes.maps.abstracts.AbstractByte2LongMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.bytes.maps.interfaces.Byte2LongMap

Methods inherited from interface java.util.Map

Constructor Detail

Byte2LongOpenHashMap

Byte2LongOpenHashMap

Byte2LongOpenHashMap

Byte2LongOpenHashMap

Byte2LongOpenHashMap

Byte2LongOpenHashMap

Byte2LongOpenHashMap

Byte2LongOpenHashMap

Byte2LongOpenHashMap

Byte2LongOpenHashMap

Byte2LongOpenHashMap

Method Detail

put

putIfAbsent

addTo

containsKey

containsKey

containsValue

containsValue

remByte

remByteOrDefault

remove

remove

remove

getLong

get

getOrDefault

byte2LongEntrySet

keySet

values

forEach

replace

replace

computeLong

computeLongIfAbsent

computeLongIfPresent

mergeLong

mergeAllLong

size

clear