Object2LongOpenHashMap (Primitive-Collections 0.2.0 API)

java.lang.Object
- java.util.AbstractMap<T,java.lang.Long>
- - speiger.src.collections.objects.maps.abstracts.AbstractObject2LongMap<T>
  - - speiger.src.collections.objects.maps.impl.hash.Object2LongOpenHashMap<T>

Type Parameters:

T - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.ToLongFunction<T>, java.util.Map<T,java.lang.Long>, Object2LongFunction<T>, Object2LongMap<T>

Direct Known Subclasses:

Object2LongLinkedOpenHashMap
```
public class Object2LongOpenHashMap<T>
extends AbstractObject2LongMap<T>
```
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.objects.maps.abstracts.AbstractObject2LongMap
  AbstractObject2LongMap.BasicEntry<T>
- 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.objects.maps.interfaces.Object2LongMap
  Object2LongMap.Entry<T>, Object2LongMap.FastEntrySet<T>

Constructor Summary

Constructors
Constructor and Description
`Object2LongOpenHashMap()` Default Constructor
`Object2LongOpenHashMap(int minCapacity)` Constructor that defines the minimum capacity
`Object2LongOpenHashMap(int minCapacity, float loadFactor)` Constructor that defines the minimum capacity and load factor
`Object2LongOpenHashMap(java.util.Map<? extends T,? extends java.lang.Long> map)` A Helper constructor that allows to create a Map with exactly the same values as the provided map.
`Object2LongOpenHashMap(java.util.Map<? extends T,? 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.
`Object2LongOpenHashMap(Object2LongMap<T> map)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`Object2LongOpenHashMap(Object2LongMap<T> map, float loadFactor)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`Object2LongOpenHashMap(T[] keys, long[] values)` Helper constructor that allow to create a map from unboxed values
`Object2LongOpenHashMap(T[] keys, java.lang.Long[] values)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`Object2LongOpenHashMap(T[] keys, long[] values, float loadFactor)` Helper constructor that allow to create a map from unboxed values
`Object2LongOpenHashMap(T[] keys, java.lang.Long[] values, float loadFactor)` Helper constructor that allow to create a map from boxed values (it will unbox them)

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`long`	`addTo(T key, long value)` A Helper method to add a primitives together.
`void`	`clear()`
`long`	`computeLong(T key, ObjectLongUnaryOperator<T> mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`long`	`computeLongIfAbsent(T key, Object2LongFunction<T> mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`long`	`computeLongIfPresent(T key, ObjectLongUnaryOperator<T> mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`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(ObjectLongConsumer<T> action)` Type Specific forEach method to reduce boxing/unboxing
`java.lang.Long`	`get(java.lang.Object key)`
`long`	`getLong(T key)` A Type Specific get method to reduce boxing/unboxing
`long`	`getOrDefault(T key, long defaultValue)` A Type Specific getOrDefault method to reduce boxing/unboxing
`ObjectSet<T>`	`keySet()`
`void`	`mergeAllLong(Object2LongMap<T> m, LongLongUnaryOperator mappingFunction)` A Bulk method for merging Maps.
`long`	`mergeLong(T key, long value, LongLongUnaryOperator mappingFunction)` A Type Specific merge method to reduce boxing/unboxing
`ObjectSet<Object2LongMap.Entry<T>>`	`object2LongEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`long`	`put(T key, long value)` Type Specific method to reduce boxing/unboxing of values
`long`	`putIfAbsent(T key, long value)` Type Specific method to reduce boxing/unboxing of values
`long`	`rem(T key)` Type Specific remove function to reduce boxing/unboxing
`long`	`remOrDefault(T key, long defaultValue)` Type-Specific Remove function with a default return value if wanted.
`java.lang.Long`	`remove(java.lang.Object key)` Deprecated.
`boolean`	`remove(java.lang.Object key, java.lang.Object value)`
`boolean`	`remove(T key, long value)` Type Specific remove function to reduce boxing/unboxing
`long`	`replace(T key, long value)` A Type Specific replace method to reduce boxing/unboxing replace an existing value
`boolean`	`replace(T 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.objects.maps.abstracts.AbstractObject2LongMap
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.objects.maps.interfaces.Object2LongMap
compute, computeIfAbsent, computeIfPresent, forEach, merge, put, putAll, putIfAbsent, replace, replace, replaceAll

Methods inherited from interface java.util.Map
isEmpty

Methods inherited from interface speiger.src.collections.objects.functions.function.Object2LongFunction
applyAsLong

- Constructor Detail
  - Object2LongOpenHashMap
```
public Object2LongOpenHashMap()
```
    Default Constructor
  - Object2LongOpenHashMap
```
public Object2LongOpenHashMap(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
  - Object2LongOpenHashMap
```
public Object2LongOpenHashMap(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
  - Object2LongOpenHashMap
```
public Object2LongOpenHashMap(T[] 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
  - Object2LongOpenHashMap
```
public Object2LongOpenHashMap(T[] 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
  - Object2LongOpenHashMap
```
public Object2LongOpenHashMap(T[] 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
  - Object2LongOpenHashMap
```
public Object2LongOpenHashMap(T[] 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
  - Object2LongOpenHashMap
```
public Object2LongOpenHashMap(java.util.Map<? extends T,? 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
  - Object2LongOpenHashMap
```
public Object2LongOpenHashMap(java.util.Map<? extends T,? 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
  - Object2LongOpenHashMap
```
public Object2LongOpenHashMap(Object2LongMap<T> 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
  - Object2LongOpenHashMap
```
public Object2LongOpenHashMap(Object2LongMap<T> 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(T key,
                long value)
```
    Description copied from interface: Object2LongMap
    
    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(T key,
                        long value)
```
    Description copied from interface: Object2LongMap
    
    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(T key,
                  long value)
```
    Description copied from interface: Object2LongMap
    
    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
```
@Deprecated
public boolean containsKey(java.lang.Object key)
```
    Deprecated.
    
    Specified by:
    
    containsKey in interface java.util.Map<T,java.lang.Long>
    
    Overrides:
    
    containsKey in class AbstractObject2LongMap<T>
  - containsValue
```
public boolean containsValue(long value)
```
    Description copied from interface: Object2LongMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    containsValue in interface Object2LongMap<T>
    
    Overrides:
    
    containsValue in class AbstractObject2LongMap<T>
    
    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<T,java.lang.Long>
    
    Specified by:
    
    containsValue in interface Object2LongMap<T>
    
    Overrides:
    
    containsValue in class java.util.AbstractMap<T,java.lang.Long>
    
    Parameters:
    
    value - that is searched for.
    
    Returns:
    
    true if found
    
    See Also:
    
    Map.containsValue(Object)
  - rem
```
public long rem(T key)
```
    Description copied from interface: Object2LongMap
    
    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
  - remOrDefault
```
public long remOrDefault(T key,
                         long defaultValue)
```
    Description copied from interface: Object2LongMap
    
    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<T,java.lang.Long>
    
    Specified by:
    
    remove in interface Object2LongMap<T>
    
    Overrides:
    
    remove in class java.util.AbstractMap<T,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(T key,
                      long value)
```
    Description copied from interface: Object2LongMap
    
    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(T key)
```
    Description copied from interface: Object2LongMap
    
    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<T,java.lang.Long>
    
    Specified by:
    
    get in interface Object2LongMap<T>
    
    Overrides:
    
    get in class AbstractObject2LongMap<T>
  - getOrDefault
```
public long getOrDefault(T key,
                         long defaultValue)
```
    Description copied from interface: Object2LongMap
    
    A Type Specific getOrDefault method to reduce boxing/unboxing
    
    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
  - object2LongEntrySet
```
public ObjectSet<Object2LongMap.Entry<T>> object2LongEntrySet()
```
    Description copied from interface: Object2LongMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Returns:
    
    a EntrySet of the collection
  - keySet
```
public ObjectSet<T> keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<T,java.lang.Long>
    
    Specified by:
    
    keySet in interface Object2LongMap<T>
    
    Overrides:
    
    keySet in class AbstractObject2LongMap<T>
  - values
```
public LongCollection values()
```
    Specified by:
    
    values in interface java.util.Map<T,java.lang.Long>
    
    Specified by:
    
    values in interface Object2LongMap<T>
    
    Overrides:
    
    values in class AbstractObject2LongMap<T>
  - forEach
```
public void forEach(ObjectLongConsumer<T> action)
```
    Description copied from interface: Object2LongMap
    
    Type Specific forEach method to reduce boxing/unboxing
    
    Specified by:
    
    forEach in interface Object2LongMap<T>
    
    Overrides:
    
    forEach in class AbstractObject2LongMap<T>
    
    Parameters:
    
    action - processor of the values that are iterator over
  - replace
```
public boolean replace(T key,
                       long oldValue,
                       long newValue)
```
    Description copied from interface: Object2LongMap
    
    A Type Specific replace method to replace an existing value
    
    Specified by:
    
    replace in interface Object2LongMap<T>
    
    Overrides:
    
    replace in class AbstractObject2LongMap<T>
    
    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(T key,
                    long value)
```
    Description copied from interface: Object2LongMap
    
    A Type Specific replace method to reduce boxing/unboxing replace an existing value
    
    Specified by:
    
    replace in interface Object2LongMap<T>
    
    Overrides:
    
    replace in class AbstractObject2LongMap<T>
    
    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(T key,
                        ObjectLongUnaryOperator<T> mappingFunction)
```
    Description copied from interface: Object2LongMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeLong in interface Object2LongMap<T>
    
    Overrides:
    
    computeLong in class AbstractObject2LongMap<T>
    
    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(T key,
                                Object2LongFunction<T> mappingFunction)
```
    Description copied from interface: Object2LongMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeLongIfAbsent in interface Object2LongMap<T>
    
    Overrides:
    
    computeLongIfAbsent in class AbstractObject2LongMap<T>
    
    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(T key,
                                 ObjectLongUnaryOperator<T> mappingFunction)
```
    Description copied from interface: Object2LongMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeLongIfPresent in interface Object2LongMap<T>
    
    Overrides:
    
    computeLongIfPresent in class AbstractObject2LongMap<T>
    
    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(T key,
                      long value,
                      LongLongUnaryOperator mappingFunction)
```
    Description copied from interface: Object2LongMap
    
    A Type Specific merge method to reduce boxing/unboxing
    
    Specified by:
    
    mergeLong in interface Object2LongMap<T>
    
    Overrides:
    
    mergeLong in class AbstractObject2LongMap<T>
    
    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(Object2LongMap<T> m,
                         LongLongUnaryOperator mappingFunction)
```
    Description copied from interface: Object2LongMap
    
    A Bulk method for merging Maps.
    
    Specified by:
    
    mergeAllLong in interface Object2LongMap<T>
    
    Overrides:
    
    mergeAllLong in class AbstractObject2LongMap<T>
    
    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<T,java.lang.Long>
    
    Overrides:
    
    size in class java.util.AbstractMap<T,java.lang.Long>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<T,java.lang.Long>
    
    Overrides:
    
    clear in class java.util.AbstractMap<T,java.lang.Long>

Class Object2LongOpenHashMap<T>

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.objects.maps.abstracts.AbstractObject2LongMap

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

Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2LongMap

Constructor Summary

Method Summary

Methods inherited from class speiger.src.collections.objects.maps.abstracts.AbstractObject2LongMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2LongMap

Methods inherited from interface java.util.Map

Methods inherited from interface speiger.src.collections.objects.functions.function.Object2LongFunction

Constructor Detail

Object2LongOpenHashMap

Object2LongOpenHashMap

Object2LongOpenHashMap

Object2LongOpenHashMap

Object2LongOpenHashMap

Object2LongOpenHashMap

Object2LongOpenHashMap

Object2LongOpenHashMap

Object2LongOpenHashMap

Object2LongOpenHashMap

Object2LongOpenHashMap

Method Detail

put

putIfAbsent

addTo

containsKey

containsValue

containsValue

rem

remOrDefault

remove

remove

remove

getLong

get

getOrDefault

object2LongEntrySet

keySet

values

forEach

replace

replace

computeLong

computeLongIfAbsent

computeLongIfPresent

mergeLong

mergeAllLong

size

clear