Object2LongLinkedOpenCustomHashMap (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.customHash.Object2LongOpenCustomHashMap<T>
    - - speiger.src.collections.objects.maps.impl.customHash.Object2LongLinkedOpenCustomHashMap<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>, java.util.SortedMap<T,java.lang.Long>, Object2LongFunction<T>, Object2LongMap<T>, Object2LongSortedMap<T>
```
public class Object2LongLinkedOpenCustomHashMap<T>
extends Object2LongOpenCustomHashMap<T>
implements Object2LongSortedMap<T>
```
A Type Specific LinkedHashMap that allows for custom HashControl. That uses arrays to create links between nodes. For cases where Objects/primitive do not allow hashcoding this can be really useful and provide a lot of control. This implementation of SortedMap does not support SubMaps of any kind. It implements the interface due to sortability and first/last access

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()`
`java.util.Comparator<T>`	`comparator()`
`T`	`firstKey()`
`long`	`firstLongValue()` A method to get the first Value of a Map.
`void`	`forEach(ObjectLongConsumer<T> action)` Type Specific forEach method to reduce boxing/unboxing
`long`	`getAndMoveToFirst(T key)` A Specific get method that allows to move teh given key/value int the first index.
`long`	`getAndMoveToLast(T key)` A Specific get method that allows to move teh given key/value int the last index.
`Object2LongSortedMap<T>`	`headMap(T toKey)`
`ObjectSet<T>`	`keySet()`
`T`	`lastKey()`
`long`	`lastLongValue()` A method to get the last Value of a Map.
`boolean`	`moveToFirst(T key)` A specific move method to move a given key/value to the first index.
`boolean`	`moveToLast(T key)` A specific move method to move a given key/value to the last index.
`ObjectSet<Object2LongMap.Entry<T>>`	`object2LongEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`T`	`pollFirstKey()` A method to get and remove the first Key of a Map.
`T`	`pollLastKey()` A method to get and remove the last Key of a Map.
`long`	`putAndMoveToFirst(T key, long value)` A customized put method that allows you to insert into the first index.
`long`	`putAndMoveToLast(T key, long value)` A customized put method that allows you to insert into the last index.
`Object2LongSortedMap<T>`	`subMap(T fromKey, T toKey)`
`Object2LongSortedMap<T>`	`tailMap(T fromKey)`
`LongCollection`	`values()`

Methods inherited from class speiger.src.collections.objects.maps.impl.customHash.Object2LongOpenCustomHashMap
addTo, computeLong, computeLongIfAbsent, computeLongIfPresent, containsKey, containsValue, containsValue, get, getLong, getOrDefault, mergeAllLong, mergeLong, put, putIfAbsent, rem, remOrDefault, remove, remove, remove, replace, replace, size

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 java.util.SortedMap
entrySet

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2LongMap
addTo, addToAll, compute, computeIfAbsent, computeIfPresent, computeLong, computeLongIfAbsent, computeLongIfPresent, containsValue, containsValue, entrySet, forEach, get, getDefaultReturnValue, getLong, getOrDefault, getOrDefault, merge, mergeAllLong, mergeLong, put, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, rem, remOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceLongs, replaceLongs, setDefaultReturnValue

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

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

- Constructor Detail
  - Object2LongLinkedOpenCustomHashMap
```
public Object2LongLinkedOpenCustomHashMap(ObjectStrategy<? super T> strategy)
```
    Default Constructor
    
    Parameters:
    
    strategy - the strategy that allows hash control.
    
    Throws:
    
    java.lang.NullPointerException - if Strategy is null
  - Object2LongLinkedOpenCustomHashMap
```
public Object2LongLinkedOpenCustomHashMap(int minCapacity,
                                          ObjectStrategy<? super T> strategy)
```
    Constructor that defines the minimum capacity
    
    Parameters:
    
    minCapacity - the minimum capacity the HashMap is allowed to be.
    
    strategy - the strategy that allows hash control.
    
    Throws:
    
    java.lang.NullPointerException - if Strategy is null
    
    java.lang.IllegalStateException - if the minimum capacity is negative
  - Object2LongLinkedOpenCustomHashMap
```
public Object2LongLinkedOpenCustomHashMap(int minCapacity,
                                          float loadFactor,
                                          ObjectStrategy<? super T> strategy)
```
    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
    
    strategy - the strategy that allows hash control.
    
    Throws:
    
    java.lang.NullPointerException - if Strategy is null
    
    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
  - Object2LongLinkedOpenCustomHashMap
```
public Object2LongLinkedOpenCustomHashMap(T[] keys,
                                          java.lang.Long[] values,
                                          ObjectStrategy<? super T> strategy)
```
    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.
    
    strategy - the strategy that allows hash control.
    
    Throws:
    
    java.lang.NullPointerException - if Strategy is null
    
    java.lang.IllegalStateException - if the keys and values do not match in lenght
  - Object2LongLinkedOpenCustomHashMap
```
public Object2LongLinkedOpenCustomHashMap(T[] keys,
                                          java.lang.Long[] values,
                                          float loadFactor,
                                          ObjectStrategy<? super T> strategy)
```
    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
    
    strategy - the strategy that allows hash control.
    
    Throws:
    
    java.lang.NullPointerException - if Strategy is null
    
    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
  - Object2LongLinkedOpenCustomHashMap
```
public Object2LongLinkedOpenCustomHashMap(T[] keys,
                                          long[] values,
                                          ObjectStrategy<? super T> strategy)
```
    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.
    
    strategy - the strategy that allows hash control.
    
    Throws:
    
    java.lang.NullPointerException - if Strategy is null
    
    java.lang.IllegalStateException - if the keys and values do not match in lenght
  - Object2LongLinkedOpenCustomHashMap
```
public Object2LongLinkedOpenCustomHashMap(T[] keys,
                                          long[] values,
                                          float loadFactor,
                                          ObjectStrategy<? super T> strategy)
```
    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
    
    strategy - the strategy that allows hash control.
    
    Throws:
    
    java.lang.NullPointerException - if Strategy is null
    
    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
  - Object2LongLinkedOpenCustomHashMap
```
public Object2LongLinkedOpenCustomHashMap(java.util.Map<? extends T,? extends java.lang.Long> map,
                                          ObjectStrategy<? super T> strategy)
```
    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
    
    strategy - the strategy that allows hash control.
    
    Throws:
    
    java.lang.NullPointerException - if Strategy is null
  - Object2LongLinkedOpenCustomHashMap
```
public Object2LongLinkedOpenCustomHashMap(java.util.Map<? extends T,? extends java.lang.Long> map,
                                          float loadFactor,
                                          ObjectStrategy<? super T> strategy)
```
    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
    
    strategy - the strategy that allows hash control.
    
    Throws:
    
    java.lang.NullPointerException - if Strategy is null
    
    java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1
  - Object2LongLinkedOpenCustomHashMap
```
public Object2LongLinkedOpenCustomHashMap(Object2LongMap<T> map,
                                          ObjectStrategy<? super T> strategy)
```
    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
    
    strategy - the strategy that allows hash control.
    
    Throws:
    
    java.lang.NullPointerException - if Strategy is null
  - Object2LongLinkedOpenCustomHashMap
```
public Object2LongLinkedOpenCustomHashMap(Object2LongMap<T> map,
                                          float loadFactor,
                                          ObjectStrategy<? super T> strategy)
```
    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
    
    strategy - the strategy that allows hash control.
    
    Throws:
    
    java.lang.NullPointerException - if Strategy is null
    
    java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1
- Method Detail
  - putAndMoveToFirst
```
public long putAndMoveToFirst(T key,
                              long value)
```
    Description copied from interface: Object2LongSortedMap
    
    A customized put method that allows you to insert into the first index.
    
    Specified by:
    
    putAndMoveToFirst in interface Object2LongSortedMap<T>
    
    Parameters:
    
    key - the key that should be inserted
    
    value - the value that should be inserted
    
    Returns:
    
    the previous present or default return value
    
    See Also:
    
    Map.put(Object, Object)
  - putAndMoveToLast
```
public long putAndMoveToLast(T key,
                             long value)
```
    Description copied from interface: Object2LongSortedMap
    
    A customized put method that allows you to insert into the last index. (This may be nessesary depending on the implementation)
    
    Specified by:
    
    putAndMoveToLast in interface Object2LongSortedMap<T>
    
    Parameters:
    
    key - the key that should be inserted
    
    value - the value that should be inserted
    
    Returns:
    
    the previous present or default return value
    
    See Also:
    
    Map.put(Object, Object)
  - moveToFirst
```
public boolean moveToFirst(T key)
```
    Description copied from interface: Object2LongSortedMap
    
    A specific move method to move a given key/value to the first index.
    
    Specified by:
    
    moveToFirst in interface Object2LongSortedMap<T>
    
    Parameters:
    
    key - that should be moved to the first index
    
    Returns:
    
    true if the value was moved.
  - moveToLast
```
public boolean moveToLast(T key)
```
    Description copied from interface: Object2LongSortedMap
    
    A specific move method to move a given key/value to the last index.
    
    Specified by:
    
    moveToLast in interface Object2LongSortedMap<T>
    
    Parameters:
    
    key - that should be moved to the first last
    
    Returns:
    
    true if the value was moved.
  - getAndMoveToFirst
```
public long getAndMoveToFirst(T key)
```
    Description copied from interface: Object2LongSortedMap
    
    A Specific get method that allows to move teh given key/value int the first index.
    
    Specified by:
    
    getAndMoveToFirst in interface Object2LongSortedMap<T>
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - getAndMoveToLast
```
public long getAndMoveToLast(T key)
```
    Description copied from interface: Object2LongSortedMap
    
    A Specific get method that allows to move teh given key/value int the last index.
    
    Specified by:
    
    getAndMoveToLast in interface Object2LongSortedMap<T>
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - comparator
```
public java.util.Comparator<T> comparator()
```
    Specified by:
    
    comparator in interface java.util.SortedMap<T,java.lang.Long>
    
    Specified by:
    
    comparator in interface Object2LongSortedMap<T>
  - subMap
```
public Object2LongSortedMap<T> subMap(T fromKey,
                                      T toKey)
```
    Specified by:
    
    subMap in interface java.util.SortedMap<T,java.lang.Long>
    
    Specified by:
    
    subMap in interface Object2LongSortedMap<T>
  - headMap
```
public Object2LongSortedMap<T> headMap(T toKey)
```
    Specified by:
    
    headMap in interface java.util.SortedMap<T,java.lang.Long>
    
    Specified by:
    
    headMap in interface Object2LongSortedMap<T>
  - tailMap
```
public Object2LongSortedMap<T> tailMap(T fromKey)
```
    Specified by:
    
    tailMap in interface java.util.SortedMap<T,java.lang.Long>
    
    Specified by:
    
    tailMap in interface Object2LongSortedMap<T>
  - firstKey
```
public T firstKey()
```
    Specified by:
    
    firstKey in interface java.util.SortedMap<T,java.lang.Long>
  - pollFirstKey
```
public T pollFirstKey()
```
    Description copied from interface: Object2LongSortedMap
    
    A method to get and remove the first Key of a Map.
    
    Specified by:
    
    pollFirstKey in interface Object2LongSortedMap<T>
    
    Returns:
    
    the first key in the map
  - lastKey
```
public T lastKey()
```
    Specified by:
    
    lastKey in interface java.util.SortedMap<T,java.lang.Long>
  - pollLastKey
```
public T pollLastKey()
```
    Description copied from interface: Object2LongSortedMap
    
    A method to get and remove the last Key of a Map.
    
    Specified by:
    
    pollLastKey in interface Object2LongSortedMap<T>
    
    Returns:
    
    the last key in the map
  - firstLongValue
```
public long firstLongValue()
```
    Description copied from interface: Object2LongSortedMap
    
    A method to get the first Value of a Map.
    
    Specified by:
    
    firstLongValue in interface Object2LongSortedMap<T>
    
    Returns:
    
    the first key in the map
  - lastLongValue
```
public long lastLongValue()
```
    Description copied from interface: Object2LongSortedMap
    
    A method to get the last Value of a Map.
    
    Specified by:
    
    lastLongValue in interface Object2LongSortedMap<T>
    
    Returns:
    
    the last key in the map
  - object2LongEntrySet
```
public ObjectSet<Object2LongMap.Entry<T>> object2LongEntrySet()
```
    Description copied from interface: Object2LongMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Specified by:
    
    object2LongEntrySet in interface Object2LongMap<T>
    
    Overrides:
    
    object2LongEntrySet in class Object2LongOpenCustomHashMap<T>
    
    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 java.util.SortedMap<T,java.lang.Long>
    
    Specified by:
    
    keySet in interface Object2LongMap<T>
    
    Specified by:
    
    keySet in interface Object2LongSortedMap<T>
    
    Overrides:
    
    keySet in class Object2LongOpenCustomHashMap<T>
  - values
```
public LongCollection values()
```
    Specified by:
    
    values in interface java.util.Map<T,java.lang.Long>
    
    Specified by:
    
    values in interface java.util.SortedMap<T,java.lang.Long>
    
    Specified by:
    
    values in interface Object2LongMap<T>
    
    Specified by:
    
    values in interface Object2LongSortedMap<T>
    
    Overrides:
    
    values in class Object2LongOpenCustomHashMap<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 Object2LongOpenCustomHashMap<T>
    
    Parameters:
    
    action - processor of the values that are iterator over
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<T,java.lang.Long>
    
    Overrides:
    
    clear in class Object2LongOpenCustomHashMap<T>

Class Object2LongLinkedOpenCustomHashMap<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.Object2LongSortedMap

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.impl.customHash.Object2LongOpenCustomHashMap

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 java.util.SortedMap

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

Object2LongLinkedOpenCustomHashMap

Object2LongLinkedOpenCustomHashMap

Object2LongLinkedOpenCustomHashMap

Object2LongLinkedOpenCustomHashMap

Object2LongLinkedOpenCustomHashMap

Object2LongLinkedOpenCustomHashMap

Object2LongLinkedOpenCustomHashMap

Object2LongLinkedOpenCustomHashMap

Object2LongLinkedOpenCustomHashMap

Object2LongLinkedOpenCustomHashMap

Object2LongLinkedOpenCustomHashMap

Method Detail

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

comparator

subMap

headMap

tailMap

firstKey

pollFirstKey

lastKey

pollLastKey

firstLongValue

lastLongValue

object2LongEntrySet

keySet

values

forEach

clear