Int2ObjectLinkedOpenHashMap (Primitive-Collections 0.2.0 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Integer,V>
- - speiger.src.collections.ints.maps.abstracts.AbstractInt2ObjectMap<V>
  - - speiger.src.collections.ints.maps.impl.hash.Int2ObjectOpenHashMap<V>
    - - speiger.src.collections.ints.maps.impl.hash.Int2ObjectLinkedOpenHashMap<V>

Type Parameters:

V - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.IntFunction<V>, java.util.Map<java.lang.Integer,V>, java.util.SortedMap<java.lang.Integer,V>, Int2ObjectFunction<V>, Int2ObjectMap<V>, Int2ObjectSortedMap<V>
```
public class Int2ObjectLinkedOpenHashMap<V>
extends Int2ObjectOpenHashMap<V>
implements Int2ObjectSortedMap<V>
```
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.ints.maps.abstracts.AbstractInt2ObjectMap
  AbstractInt2ObjectMap.BasicEntry<V>
- 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.ints.maps.interfaces.Int2ObjectSortedMap
  Int2ObjectSortedMap.FastSortedSet<V>
- Nested classes/interfaces inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ObjectMap
  Int2ObjectMap.Entry<V>, Int2ObjectMap.FastEntrySet<V>

Constructor Summary

Constructors
Constructor and Description
`Int2ObjectLinkedOpenHashMap()` Default Constructor
`Int2ObjectLinkedOpenHashMap(int minCapacity)` Constructor that defines the minimum capacity
`Int2ObjectLinkedOpenHashMap(int[] keys, V[] values)` Helper constructor that allow to create a map from unboxed values
`Int2ObjectLinkedOpenHashMap(int[] keys, V[] values, float loadFactor)` Helper constructor that allow to create a map from unboxed values
`Int2ObjectLinkedOpenHashMap(Int2ObjectMap<V> map)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`Int2ObjectLinkedOpenHashMap(Int2ObjectMap<V> map, float loadFactor)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`Int2ObjectLinkedOpenHashMap(java.lang.Integer[] keys, V[] values)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`Int2ObjectLinkedOpenHashMap(java.lang.Integer[] keys, V[] values, float loadFactor)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`Int2ObjectLinkedOpenHashMap(int minCapacity, float loadFactor)` Constructor that defines the minimum capacity and load factor
`Int2ObjectLinkedOpenHashMap(java.util.Map<? extends java.lang.Integer,? extends V> map)` A Helper constructor that allows to create a Map with exactly the same values as the provided map.
`Int2ObjectLinkedOpenHashMap(java.util.Map<? extends java.lang.Integer,? extends V> 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
Modifier and Type	Method and Description
`void`	`clear()`
`IntComparator`	`comparator()`
`int`	`firstIntKey()` A method to get the first Key of a Map.
`V`	`firstValue()` A method to get the first Value of a Map.
`void`	`forEach(IntObjectConsumer<V> action)` Type Specific forEach method to reduce boxing/unboxing
`V`	`getAndMoveToFirst(int key)` A Specific get method that allows to move teh given key/value int the first index.
`V`	`getAndMoveToLast(int key)` A Specific get method that allows to move teh given key/value int the last index.
`Int2ObjectSortedMap<V>`	`headMap(int toKey)` A Type Specific HeadMap method to reduce boxing/unboxing
`ObjectSet<Int2ObjectMap.Entry<V>>`	`int2ObjectEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`IntSet`	`keySet()`
`int`	`lastIntKey()` A method to get the last Key of a Map.
`V`	`lastValue()` A method to get the last Value of a Map.
`boolean`	`moveToFirst(int key)` A specific move method to move a given key/value to the first index.
`boolean`	`moveToLast(int key)` A specific move method to move a given key/value to the last index.
`int`	`pollFirstIntKey()` A method to get and remove the first Key of a Map.
`int`	`pollLastIntKey()` A method to get and remove the last Key of a Map.
`V`	`putAndMoveToFirst(int key, V value)` A customized put method that allows you to insert into the first index.
`V`	`putAndMoveToLast(int key, V value)` A customized put method that allows you to insert into the last index.
`Int2ObjectSortedMap<V>`	`subMap(int fromKey, int toKey)` A Type Specific SubMap method to reduce boxing/unboxing
`Int2ObjectSortedMap<V>`	`tailMap(int fromKey)` A Type Specific TailMap method to reduce boxing/unboxing
`ObjectCollection<V>`	`values()`

Methods inherited from class speiger.src.collections.ints.maps.impl.hash.Int2ObjectOpenHashMap
compute, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, get, getObject, getOrDefault, merge, mergeAll, put, putIfAbsent, remInt, remIntOrDefault, remove, remove, remove, replace, replace, size

Methods inherited from class speiger.src.collections.ints.maps.abstracts.AbstractInt2ObjectMap
entrySet, equals, getDefaultReturnValue, getOrDefault, hashCode, putAll, putAll, putAll, putAllIfAbsent, replaceObjects, replaceObjects, 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.ints.maps.interfaces.Int2ObjectSortedMap
firstKey, headMap, lastKey, subMap, tailMap

Methods inherited from interface java.util.SortedMap
entrySet

Methods inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ObjectMap
compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, entrySet, forEach, get, getDefaultReturnValue, getObject, getOrDefault, getOrDefault, merge, merge, mergeAll, put, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remInt, remIntOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue

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

Methods inherited from interface speiger.src.collections.ints.functions.function.Int2ObjectFunction
apply

- Constructor Detail
  - Int2ObjectLinkedOpenHashMap
```
public Int2ObjectLinkedOpenHashMap()
```
    Default Constructor
  - Int2ObjectLinkedOpenHashMap
```
public Int2ObjectLinkedOpenHashMap(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
  - Int2ObjectLinkedOpenHashMap
```
public Int2ObjectLinkedOpenHashMap(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
  - Int2ObjectLinkedOpenHashMap
```
public Int2ObjectLinkedOpenHashMap(java.lang.Integer[] keys,
                                   V[] 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
  - Int2ObjectLinkedOpenHashMap
```
public Int2ObjectLinkedOpenHashMap(java.lang.Integer[] keys,
                                   V[] 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
  - Int2ObjectLinkedOpenHashMap
```
public Int2ObjectLinkedOpenHashMap(int[] keys,
                                   V[] 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
  - Int2ObjectLinkedOpenHashMap
```
public Int2ObjectLinkedOpenHashMap(int[] keys,
                                   V[] 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
  - Int2ObjectLinkedOpenHashMap
```
public Int2ObjectLinkedOpenHashMap(java.util.Map<? extends java.lang.Integer,? extends V> 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
  - Int2ObjectLinkedOpenHashMap
```
public Int2ObjectLinkedOpenHashMap(java.util.Map<? extends java.lang.Integer,? extends V> 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
  - Int2ObjectLinkedOpenHashMap
```
public Int2ObjectLinkedOpenHashMap(Int2ObjectMap<V> 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
  - Int2ObjectLinkedOpenHashMap
```
public Int2ObjectLinkedOpenHashMap(Int2ObjectMap<V> 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 V putAndMoveToFirst(int key,
                           V value)
```
    Description copied from interface: Int2ObjectSortedMap
    
    A customized put method that allows you to insert into the first index.
    
    Specified by:
    
    putAndMoveToFirst in interface Int2ObjectSortedMap<V>
    
    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 V putAndMoveToLast(int key,
                          V value)
```
    Description copied from interface: Int2ObjectSortedMap
    
    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 Int2ObjectSortedMap<V>
    
    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(int key)
```
    Description copied from interface: Int2ObjectSortedMap
    
    A specific move method to move a given key/value to the first index.
    
    Specified by:
    
    moveToFirst in interface Int2ObjectSortedMap<V>
    
    Parameters:
    
    key - that should be moved to the first index
    
    Returns:
    
    true if the value was moved.
  - moveToLast
```
public boolean moveToLast(int key)
```
    Description copied from interface: Int2ObjectSortedMap
    
    A specific move method to move a given key/value to the last index.
    
    Specified by:
    
    moveToLast in interface Int2ObjectSortedMap<V>
    
    Parameters:
    
    key - that should be moved to the first last
    
    Returns:
    
    true if the value was moved.
  - getAndMoveToFirst
```
public V getAndMoveToFirst(int key)
```
    Description copied from interface: Int2ObjectSortedMap
    
    A Specific get method that allows to move teh given key/value int the first index.
    
    Specified by:
    
    getAndMoveToFirst in interface Int2ObjectSortedMap<V>
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - getAndMoveToLast
```
public V getAndMoveToLast(int key)
```
    Description copied from interface: Int2ObjectSortedMap
    
    A Specific get method that allows to move teh given key/value int the last index.
    
    Specified by:
    
    getAndMoveToLast in interface Int2ObjectSortedMap<V>
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - comparator
```
public IntComparator comparator()
```
    Specified by:
    
    comparator in interface java.util.SortedMap<java.lang.Integer,V>
    
    Specified by:
    
    comparator in interface Int2ObjectSortedMap<V>
  - subMap
```
public Int2ObjectSortedMap<V> subMap(int fromKey,
                                     int toKey)
```
    Description copied from interface: Int2ObjectSortedMap
    
    A Type Specific SubMap method to reduce boxing/unboxing
    
    Specified by:
    
    subMap in interface Int2ObjectSortedMap<V>
    
    Parameters:
    
    fromKey - where the submap should start
    
    toKey - where the subMap should end
    
    Returns:
    
    a SubMap that is within the range of the desired range
  - headMap
```
public Int2ObjectSortedMap<V> headMap(int toKey)
```
    Description copied from interface: Int2ObjectSortedMap
    
    A Type Specific HeadMap method to reduce boxing/unboxing
    
    Specified by:
    
    headMap in interface Int2ObjectSortedMap<V>
    
    Parameters:
    
    toKey - where the headMap should end
    
    Returns:
    
    a HeadMap that is within the range of the desired range
  - tailMap
```
public Int2ObjectSortedMap<V> tailMap(int fromKey)
```
    Description copied from interface: Int2ObjectSortedMap
    
    A Type Specific TailMap method to reduce boxing/unboxing
    
    Specified by:
    
    tailMap in interface Int2ObjectSortedMap<V>
    
    Parameters:
    
    fromKey - where the TailMap should start
    
    Returns:
    
    a TailMap that is within the range of the desired range
  - firstIntKey
```
public int firstIntKey()
```
    Description copied from interface: Int2ObjectSortedMap
    
    A method to get the first Key of a Map.
    
    Specified by:
    
    firstIntKey in interface Int2ObjectSortedMap<V>
    
    Returns:
    
    the first key in the map
  - pollFirstIntKey
```
public int pollFirstIntKey()
```
    Description copied from interface: Int2ObjectSortedMap
    
    A method to get and remove the first Key of a Map.
    
    Specified by:
    
    pollFirstIntKey in interface Int2ObjectSortedMap<V>
    
    Returns:
    
    the first key in the map
  - lastIntKey
```
public int lastIntKey()
```
    Description copied from interface: Int2ObjectSortedMap
    
    A method to get the last Key of a Map.
    
    Specified by:
    
    lastIntKey in interface Int2ObjectSortedMap<V>
    
    Returns:
    
    the last key in the map
  - pollLastIntKey
```
public int pollLastIntKey()
```
    Description copied from interface: Int2ObjectSortedMap
    
    A method to get and remove the last Key of a Map.
    
    Specified by:
    
    pollLastIntKey in interface Int2ObjectSortedMap<V>
    
    Returns:
    
    the last key in the map
  - firstValue
```
public V firstValue()
```
    Description copied from interface: Int2ObjectSortedMap
    
    A method to get the first Value of a Map.
    
    Specified by:
    
    firstValue in interface Int2ObjectSortedMap<V>
    
    Returns:
    
    the first key in the map
  - lastValue
```
public V lastValue()
```
    Description copied from interface: Int2ObjectSortedMap
    
    A method to get the last Value of a Map.
    
    Specified by:
    
    lastValue in interface Int2ObjectSortedMap<V>
    
    Returns:
    
    the last key in the map
  - int2ObjectEntrySet
```
public ObjectSet<Int2ObjectMap.Entry<V>> int2ObjectEntrySet()
```
    Description copied from interface: Int2ObjectMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Specified by:
    
    int2ObjectEntrySet in interface Int2ObjectMap<V>
    
    Overrides:
    
    int2ObjectEntrySet in class Int2ObjectOpenHashMap<V>
    
    Returns:
    
    a EntrySet of the collection
  - keySet
```
public IntSet keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Integer,V>
    
    Specified by:
    
    keySet in interface java.util.SortedMap<java.lang.Integer,V>
    
    Specified by:
    
    keySet in interface Int2ObjectMap<V>
    
    Specified by:
    
    keySet in interface Int2ObjectSortedMap<V>
    
    Overrides:
    
    keySet in class Int2ObjectOpenHashMap<V>
  - values
```
public ObjectCollection<V> values()
```
    Specified by:
    
    values in interface java.util.Map<java.lang.Integer,V>
    
    Specified by:
    
    values in interface java.util.SortedMap<java.lang.Integer,V>
    
    Specified by:
    
    values in interface Int2ObjectMap<V>
    
    Specified by:
    
    values in interface Int2ObjectSortedMap<V>
    
    Overrides:
    
    values in class Int2ObjectOpenHashMap<V>
  - forEach
```
public void forEach(IntObjectConsumer<V> action)
```
    Description copied from interface: Int2ObjectMap
    
    Type Specific forEach method to reduce boxing/unboxing
    
    Specified by:
    
    forEach in interface Int2ObjectMap<V>
    
    Overrides:
    
    forEach in class Int2ObjectOpenHashMap<V>
    
    Parameters:
    
    action - processor of the values that are iterator over
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<java.lang.Integer,V>
    
    Overrides:
    
    clear in class Int2ObjectOpenHashMap<V>

Class Int2ObjectLinkedOpenHashMap<V>

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.ints.maps.abstracts.AbstractInt2ObjectMap

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

Nested classes/interfaces inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ObjectSortedMap

Nested classes/interfaces inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ObjectMap

Constructor Summary

Method Summary

Methods inherited from class speiger.src.collections.ints.maps.impl.hash.Int2ObjectOpenHashMap

Methods inherited from class speiger.src.collections.ints.maps.abstracts.AbstractInt2ObjectMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ObjectSortedMap

Methods inherited from interface java.util.SortedMap

Methods inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ObjectMap

Methods inherited from interface java.util.Map

Methods inherited from interface speiger.src.collections.ints.functions.function.Int2ObjectFunction

Constructor Detail

Int2ObjectLinkedOpenHashMap

Int2ObjectLinkedOpenHashMap

Int2ObjectLinkedOpenHashMap

Int2ObjectLinkedOpenHashMap

Int2ObjectLinkedOpenHashMap

Int2ObjectLinkedOpenHashMap

Int2ObjectLinkedOpenHashMap

Int2ObjectLinkedOpenHashMap

Int2ObjectLinkedOpenHashMap

Int2ObjectLinkedOpenHashMap

Int2ObjectLinkedOpenHashMap

Method Detail

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

comparator

subMap

headMap

tailMap

firstIntKey

pollFirstIntKey

lastIntKey

pollLastIntKey

firstValue

lastValue

int2ObjectEntrySet

keySet

values

forEach

clear