Object2LongLinkedOpenHashMap (Primitive-Collections 0.7.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>
    - - speiger.src.collections.objects.maps.impl.hash.Object2LongLinkedOpenHashMap<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>, Object2LongOrderedMap<T>, ITrimmable
```
public class Object2LongLinkedOpenHashMap<T>
extends Object2LongOpenHashMap<T>
implements Object2LongOrderedMap<T>
```
A Type Specific LinkedHashMap implementation that uses specific arrays to create links between nodes to remove the wrapping of elements to greatly reduce memory usage. In Addition adding some helper methods to move around elements. 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.Object2LongOrderedMap
  Object2LongOrderedMap.FastOrderedSet<T>
- Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2LongMap
  Object2LongMap.BuilderCache<T>, Object2LongMap.Entry<T>, Object2LongMap.FastEntrySet<T>, Object2LongMap.MapBuilder

Constructor Summary

Constructors
Constructor and Description
`Object2LongLinkedOpenHashMap()` Default Constructor
`Object2LongLinkedOpenHashMap(int minCapacity)` Constructor that defines the minimum capacity
`Object2LongLinkedOpenHashMap(int minCapacity, float loadFactor)` Constructor that defines the minimum capacity and load factor
`Object2LongLinkedOpenHashMap(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.
`Object2LongLinkedOpenHashMap(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.
`Object2LongLinkedOpenHashMap(Object2LongMap<T> map)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`Object2LongLinkedOpenHashMap(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.
`Object2LongLinkedOpenHashMap(T[] keys, long[] values)` Helper constructor that allow to create a map from unboxed values
`Object2LongLinkedOpenHashMap(T[] keys, java.lang.Long[] values)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`Object2LongLinkedOpenHashMap(T[] keys, long[] values, float loadFactor)` Helper constructor that allow to create a map from unboxed values
`Object2LongLinkedOpenHashMap(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
`void`	`clear()`
`void`	`clearAndTrim(int size)` Trims the collection down to the requested size and clears all elements while doing so
`boolean`	`containsValue(long value)` Type Specific method to reduce boxing/unboxing of values
`boolean`	`containsValue(java.lang.Object value)` Deprecated.
`Object2LongLinkedOpenHashMap<T>`	`copy()` A Function that does a shallow clone of the Map itself.
`T`	`firstKey()` A method to get the first Key of a Map.
`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.
`ObjectOrderedSet<T>`	`keySet()`
`T`	`lastKey()` A method to get the last Key of a Map.
`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.
`ObjectOrderedSet<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.
`LongCollection`	`values()`

Methods inherited from class speiger.src.collections.objects.maps.impl.hash.Object2LongOpenHashMap
addTo, computeLong, computeLongIfAbsent, computeLongIfPresent, containsKey, get, getLong, getOrDefault, mergeAllLong, mergeLong, put, putIfAbsent, rem, remOrDefault, remove, remove, remove, replace, replace, size, subFrom, supplyLongIfAbsent, trim

Methods inherited from class speiger.src.collections.objects.maps.abstracts.AbstractObject2LongMap
addToAll, entrySet, equals, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, replaceLongs, replaceLongs, setDefaultReturnValue

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

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

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2LongOrderedMap
synchronize, synchronize, unmodifiable

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

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

Methods inherited from interface speiger.src.collections.utils.ITrimmable
clearAndTrim, trim

- Constructor Detail
  - Object2LongLinkedOpenHashMap
```
public Object2LongLinkedOpenHashMap()
```
    Default Constructor
  - Object2LongLinkedOpenHashMap
```
public Object2LongLinkedOpenHashMap(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
  - Object2LongLinkedOpenHashMap
```
public Object2LongLinkedOpenHashMap(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
  - Object2LongLinkedOpenHashMap
```
public Object2LongLinkedOpenHashMap(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
  - Object2LongLinkedOpenHashMap
```
public Object2LongLinkedOpenHashMap(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
  - Object2LongLinkedOpenHashMap
```
public Object2LongLinkedOpenHashMap(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
  - Object2LongLinkedOpenHashMap
```
public Object2LongLinkedOpenHashMap(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
  - Object2LongLinkedOpenHashMap
```
public Object2LongLinkedOpenHashMap(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
  - Object2LongLinkedOpenHashMap
```
public Object2LongLinkedOpenHashMap(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
  - Object2LongLinkedOpenHashMap
```
public Object2LongLinkedOpenHashMap(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
  - Object2LongLinkedOpenHashMap
```
public Object2LongLinkedOpenHashMap(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
  - putAndMoveToFirst
```
public long putAndMoveToFirst(T key,
                              long value)
```
    Description copied from interface: Object2LongOrderedMap
    
    A customized put method that allows you to insert into the first index.
    
    Specified by:
    
    putAndMoveToFirst in interface Object2LongOrderedMap<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: Object2LongOrderedMap
    
    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 Object2LongOrderedMap<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: Object2LongOrderedMap
    
    A specific move method to move a given key/value to the first index.
    
    Specified by:
    
    moveToFirst in interface Object2LongOrderedMap<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: Object2LongOrderedMap
    
    A specific move method to move a given key/value to the last index.
    
    Specified by:
    
    moveToLast in interface Object2LongOrderedMap<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: Object2LongOrderedMap
    
    A Specific get method that allows to move teh given key/value int the first index.
    
    Specified by:
    
    getAndMoveToFirst in interface Object2LongOrderedMap<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: Object2LongOrderedMap
    
    A Specific get method that allows to move teh given key/value int the last index.
    
    Specified by:
    
    getAndMoveToLast in interface Object2LongOrderedMap<T>
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - 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 Object2LongOpenHashMap<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 Object2LongOpenHashMap<T>
    
    Parameters:
    
    value - that is searched for.
    
    Returns:
    
    true if found
    
    See Also:
    
    Map.containsValue(Object)
  - copy
```
public Object2LongLinkedOpenHashMap<T> copy()
```
    Description copied from interface: Object2LongMap
    
    A Function that does a shallow clone of the Map itself. This function is more optimized then a copy constructor since the Map does not have to be unsorted/resorted. It can be compared to Cloneable but with less exception risk
    
    Specified by:
    
    copy in interface Object2LongMap<T>
    
    Specified by:
    
    copy in interface Object2LongOrderedMap<T>
    
    Overrides:
    
    copy in class Object2LongOpenHashMap<T>
    
    Returns:
    
    a Shallow Copy of the Map
  - firstKey
```
public T firstKey()
```
    Description copied from interface: Object2LongOrderedMap
    
    A method to get the first Key of a Map.
    
    Specified by:
    
    firstKey in interface Object2LongOrderedMap<T>
    
    Returns:
    
    the first key in the map
  - pollFirstKey
```
public T pollFirstKey()
```
    Description copied from interface: Object2LongOrderedMap
    
    A method to get and remove the first Key of a Map.
    
    Specified by:
    
    pollFirstKey in interface Object2LongOrderedMap<T>
    
    Returns:
    
    the first key in the map
  - lastKey
```
public T lastKey()
```
    Description copied from interface: Object2LongOrderedMap
    
    A method to get the last Key of a Map.
    
    Specified by:
    
    lastKey in interface Object2LongOrderedMap<T>
    
    Returns:
    
    the last key in the map
  - pollLastKey
```
public T pollLastKey()
```
    Description copied from interface: Object2LongOrderedMap
    
    A method to get and remove the last Key of a Map.
    
    Specified by:
    
    pollLastKey in interface Object2LongOrderedMap<T>
    
    Returns:
    
    the last key in the map
  - firstLongValue
```
public long firstLongValue()
```
    Description copied from interface: Object2LongOrderedMap
    
    A method to get the first Value of a Map.
    
    Specified by:
    
    firstLongValue in interface Object2LongOrderedMap<T>
    
    Returns:
    
    the first key in the map
  - lastLongValue
```
public long lastLongValue()
```
    Description copied from interface: Object2LongOrderedMap
    
    A method to get the last Value of a Map.
    
    Specified by:
    
    lastLongValue in interface Object2LongOrderedMap<T>
    
    Returns:
    
    the last key in the map
  - object2LongEntrySet
```
public ObjectOrderedSet<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>
    
    Specified by:
    
    object2LongEntrySet in interface Object2LongOrderedMap<T>
    
    Overrides:
    
    object2LongEntrySet in class Object2LongOpenHashMap<T>
    
    Returns:
    
    a EntrySet of the collection
  - keySet
```
public ObjectOrderedSet<T> keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<T,java.lang.Long>
    
    Specified by:
    
    keySet in interface Object2LongMap<T>
    
    Specified by:
    
    keySet in interface Object2LongOrderedMap<T>
    
    Overrides:
    
    keySet in class Object2LongOpenHashMap<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 Object2LongOpenHashMap<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 Object2LongOpenHashMap<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 Object2LongOpenHashMap<T>
  - clearAndTrim
```
public void clearAndTrim(int size)
```
    Description copied from interface: ITrimmable
    
    Trims the collection down to the requested size and clears all elements while doing so
    
    Specified by:
    
    clearAndTrim in interface ITrimmable
    
    Overrides:
    
    clearAndTrim in class Object2LongOpenHashMap<T>
    
    Parameters:
    
    size - the amount of elements that should be allowed

Class Object2LongLinkedOpenHashMap<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.Object2LongOrderedMap

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.hash.Object2LongOpenHashMap

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.Object2LongOrderedMap

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

Methods inherited from interface speiger.src.collections.utils.ITrimmable

Constructor Detail

Object2LongLinkedOpenHashMap

Object2LongLinkedOpenHashMap

Object2LongLinkedOpenHashMap

Object2LongLinkedOpenHashMap

Object2LongLinkedOpenHashMap

Object2LongLinkedOpenHashMap

Object2LongLinkedOpenHashMap

Object2LongLinkedOpenHashMap

Object2LongLinkedOpenHashMap

Object2LongLinkedOpenHashMap

Object2LongLinkedOpenHashMap

Method Detail

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

containsValue

containsValue

copy

firstKey

pollFirstKey

lastKey

pollLastKey

firstLongValue

lastLongValue

object2LongEntrySet

keySet

values

forEach

clear

clearAndTrim