Object2ShortLinkedOpenCustomHashMap (Primitive-Collections 0.2.0 API)

java.lang.Object
- java.util.AbstractMap<T,java.lang.Short>
- - speiger.src.collections.objects.maps.abstracts.AbstractObject2ShortMap<T>
  - - speiger.src.collections.objects.maps.impl.customHash.Object2ShortOpenCustomHashMap<T>
    - - speiger.src.collections.objects.maps.impl.customHash.Object2ShortLinkedOpenCustomHashMap<T>

Type Parameters:

T - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.Map<T,java.lang.Short>, java.util.SortedMap<T,java.lang.Short>, Object2ShortFunction<T>, Object2ShortMap<T>, Object2ShortSortedMap<T>
```
public class Object2ShortLinkedOpenCustomHashMap<T>
extends Object2ShortOpenCustomHashMap<T>
implements Object2ShortSortedMap<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.AbstractObject2ShortMap
  AbstractObject2ShortMap.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.Object2ShortSortedMap
  Object2ShortSortedMap.FastSortedSet<T>
- Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2ShortMap
  Object2ShortMap.Entry<T>, Object2ShortMap.FastEntrySet<T>

Constructor Summary

Constructors
Constructor and Description
`Object2ShortLinkedOpenCustomHashMap(int minCapacity, float loadFactor, ObjectStrategy<? super T> strategy)` Constructor that defines the minimum capacity and load factor
`Object2ShortLinkedOpenCustomHashMap(int minCapacity, ObjectStrategy<? super T> strategy)` Constructor that defines the minimum capacity
`Object2ShortLinkedOpenCustomHashMap(java.util.Map<? extends T,? extends java.lang.Short> 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.
`Object2ShortLinkedOpenCustomHashMap(java.util.Map<? extends T,? extends java.lang.Short> map, ObjectStrategy<? super T> strategy)` A Helper constructor that allows to create a Map with exactly the same values as the provided map.
`Object2ShortLinkedOpenCustomHashMap(Object2ShortMap<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.
`Object2ShortLinkedOpenCustomHashMap(Object2ShortMap<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.
`Object2ShortLinkedOpenCustomHashMap(ObjectStrategy<? super T> strategy)` Default Constructor
`Object2ShortLinkedOpenCustomHashMap(T[] keys, short[] values, float loadFactor, ObjectStrategy<? super T> strategy)` Helper constructor that allow to create a map from unboxed values
`Object2ShortLinkedOpenCustomHashMap(T[] keys, java.lang.Short[] values, float loadFactor, ObjectStrategy<? super T> strategy)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`Object2ShortLinkedOpenCustomHashMap(T[] keys, short[] values, ObjectStrategy<? super T> strategy)` Helper constructor that allow to create a map from unboxed values
`Object2ShortLinkedOpenCustomHashMap(T[] keys, java.lang.Short[] 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()`
`short`	`firstShortValue()` A method to get the first Value of a Map.
`void`	`forEach(ObjectShortConsumer<T> action)` Type Specific forEach method to reduce boxing/unboxing
`short`	`getAndMoveToFirst(T key)` A Specific get method that allows to move teh given key/value int the first index.
`short`	`getAndMoveToLast(T key)` A Specific get method that allows to move teh given key/value int the last index.
`Object2ShortSortedMap<T>`	`headMap(T toKey)`
`ObjectSet<T>`	`keySet()`
`T`	`lastKey()`
`short`	`lastShortValue()` 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<Object2ShortMap.Entry<T>>`	`object2ShortEntrySet()` 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.
`short`	`putAndMoveToFirst(T key, short value)` A customized put method that allows you to insert into the first index.
`short`	`putAndMoveToLast(T key, short value)` A customized put method that allows you to insert into the last index.
`Object2ShortSortedMap<T>`	`subMap(T fromKey, T toKey)`
`Object2ShortSortedMap<T>`	`tailMap(T fromKey)`
`ShortCollection`	`values()`

Methods inherited from class speiger.src.collections.objects.maps.impl.customHash.Object2ShortOpenCustomHashMap
addTo, computeShort, computeShortIfAbsent, computeShortIfPresent, containsKey, containsValue, containsValue, get, getOrDefault, getShort, mergeAllShort, mergeShort, put, putIfAbsent, rem, remOrDefault, remove, remove, remove, replace, replace, size

Methods inherited from class speiger.src.collections.objects.maps.abstracts.AbstractObject2ShortMap
addToAll, entrySet, equals, getDefaultReturnValue, getOrDefault, hashCode, putAll, putAll, putAll, putAllIfAbsent, replaceShorts, replaceShorts, 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.Object2ShortMap
addTo, addToAll, compute, computeIfAbsent, computeIfPresent, computeShort, computeShortIfAbsent, computeShortIfPresent, containsValue, containsValue, entrySet, forEach, get, getDefaultReturnValue, getOrDefault, getOrDefault, getShort, merge, mergeAllShort, mergeShort, put, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, rem, remOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceShorts, replaceShorts, setDefaultReturnValue

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

- Constructor Detail
  - Object2ShortLinkedOpenCustomHashMap
```
public Object2ShortLinkedOpenCustomHashMap(ObjectStrategy<? super T> strategy)
```
    Default Constructor
    
    Parameters:
    
    strategy - the strategy that allows hash control.
    
    Throws:
    
    java.lang.NullPointerException - if Strategy is null
  - Object2ShortLinkedOpenCustomHashMap
```
public Object2ShortLinkedOpenCustomHashMap(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
  - Object2ShortLinkedOpenCustomHashMap
```
public Object2ShortLinkedOpenCustomHashMap(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
  - Object2ShortLinkedOpenCustomHashMap
```
public Object2ShortLinkedOpenCustomHashMap(T[] keys,
                                           java.lang.Short[] 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
  - Object2ShortLinkedOpenCustomHashMap
```
public Object2ShortLinkedOpenCustomHashMap(T[] keys,
                                           java.lang.Short[] 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
  - Object2ShortLinkedOpenCustomHashMap
```
public Object2ShortLinkedOpenCustomHashMap(T[] keys,
                                           short[] 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
  - Object2ShortLinkedOpenCustomHashMap
```
public Object2ShortLinkedOpenCustomHashMap(T[] keys,
                                           short[] 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
  - Object2ShortLinkedOpenCustomHashMap
```
public Object2ShortLinkedOpenCustomHashMap(java.util.Map<? extends T,? extends java.lang.Short> 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
  - Object2ShortLinkedOpenCustomHashMap
```
public Object2ShortLinkedOpenCustomHashMap(java.util.Map<? extends T,? extends java.lang.Short> 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
  - Object2ShortLinkedOpenCustomHashMap
```
public Object2ShortLinkedOpenCustomHashMap(Object2ShortMap<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
  - Object2ShortLinkedOpenCustomHashMap
```
public Object2ShortLinkedOpenCustomHashMap(Object2ShortMap<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 short putAndMoveToFirst(T key,
                               short value)
```
    Description copied from interface: Object2ShortSortedMap
    
    A customized put method that allows you to insert into the first index.
    
    Specified by:
    
    putAndMoveToFirst in interface Object2ShortSortedMap<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 short putAndMoveToLast(T key,
                              short value)
```
    Description copied from interface: Object2ShortSortedMap
    
    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 Object2ShortSortedMap<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: Object2ShortSortedMap
    
    A specific move method to move a given key/value to the first index.
    
    Specified by:
    
    moveToFirst in interface Object2ShortSortedMap<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: Object2ShortSortedMap
    
    A specific move method to move a given key/value to the last index.
    
    Specified by:
    
    moveToLast in interface Object2ShortSortedMap<T>
    
    Parameters:
    
    key - that should be moved to the first last
    
    Returns:
    
    true if the value was moved.
  - getAndMoveToFirst
```
public short getAndMoveToFirst(T key)
```
    Description copied from interface: Object2ShortSortedMap
    
    A Specific get method that allows to move teh given key/value int the first index.
    
    Specified by:
    
    getAndMoveToFirst in interface Object2ShortSortedMap<T>
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - getAndMoveToLast
```
public short getAndMoveToLast(T key)
```
    Description copied from interface: Object2ShortSortedMap
    
    A Specific get method that allows to move teh given key/value int the last index.
    
    Specified by:
    
    getAndMoveToLast in interface Object2ShortSortedMap<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.Short>
    
    Specified by:
    
    comparator in interface Object2ShortSortedMap<T>
  - subMap
```
public Object2ShortSortedMap<T> subMap(T fromKey,
                                       T toKey)
```
    Specified by:
    
    subMap in interface java.util.SortedMap<T,java.lang.Short>
    
    Specified by:
    
    subMap in interface Object2ShortSortedMap<T>
  - headMap
```
public Object2ShortSortedMap<T> headMap(T toKey)
```
    Specified by:
    
    headMap in interface java.util.SortedMap<T,java.lang.Short>
    
    Specified by:
    
    headMap in interface Object2ShortSortedMap<T>
  - tailMap
```
public Object2ShortSortedMap<T> tailMap(T fromKey)
```
    Specified by:
    
    tailMap in interface java.util.SortedMap<T,java.lang.Short>
    
    Specified by:
    
    tailMap in interface Object2ShortSortedMap<T>
  - firstKey
```
public T firstKey()
```
    Specified by:
    
    firstKey in interface java.util.SortedMap<T,java.lang.Short>
  - pollFirstKey
```
public T pollFirstKey()
```
    Description copied from interface: Object2ShortSortedMap
    
    A method to get and remove the first Key of a Map.
    
    Specified by:
    
    pollFirstKey in interface Object2ShortSortedMap<T>
    
    Returns:
    
    the first key in the map
  - lastKey
```
public T lastKey()
```
    Specified by:
    
    lastKey in interface java.util.SortedMap<T,java.lang.Short>
  - pollLastKey
```
public T pollLastKey()
```
    Description copied from interface: Object2ShortSortedMap
    
    A method to get and remove the last Key of a Map.
    
    Specified by:
    
    pollLastKey in interface Object2ShortSortedMap<T>
    
    Returns:
    
    the last key in the map
  - firstShortValue
```
public short firstShortValue()
```
    Description copied from interface: Object2ShortSortedMap
    
    A method to get the first Value of a Map.
    
    Specified by:
    
    firstShortValue in interface Object2ShortSortedMap<T>
    
    Returns:
    
    the first key in the map
  - lastShortValue
```
public short lastShortValue()
```
    Description copied from interface: Object2ShortSortedMap
    
    A method to get the last Value of a Map.
    
    Specified by:
    
    lastShortValue in interface Object2ShortSortedMap<T>
    
    Returns:
    
    the last key in the map
  - object2ShortEntrySet
```
public ObjectSet<Object2ShortMap.Entry<T>> object2ShortEntrySet()
```
    Description copied from interface: Object2ShortMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Specified by:
    
    object2ShortEntrySet in interface Object2ShortMap<T>
    
    Overrides:
    
    object2ShortEntrySet in class Object2ShortOpenCustomHashMap<T>
    
    Returns:
    
    a EntrySet of the collection
  - keySet
```
public ObjectSet<T> keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<T,java.lang.Short>
    
    Specified by:
    
    keySet in interface java.util.SortedMap<T,java.lang.Short>
    
    Specified by:
    
    keySet in interface Object2ShortMap<T>
    
    Specified by:
    
    keySet in interface Object2ShortSortedMap<T>
    
    Overrides:
    
    keySet in class Object2ShortOpenCustomHashMap<T>
  - values
```
public ShortCollection values()
```
    Specified by:
    
    values in interface java.util.Map<T,java.lang.Short>
    
    Specified by:
    
    values in interface java.util.SortedMap<T,java.lang.Short>
    
    Specified by:
    
    values in interface Object2ShortMap<T>
    
    Specified by:
    
    values in interface Object2ShortSortedMap<T>
    
    Overrides:
    
    values in class Object2ShortOpenCustomHashMap<T>
  - forEach
```
public void forEach(ObjectShortConsumer<T> action)
```
    Description copied from interface: Object2ShortMap
    
    Type Specific forEach method to reduce boxing/unboxing
    
    Specified by:
    
    forEach in interface Object2ShortMap<T>
    
    Overrides:
    
    forEach in class Object2ShortOpenCustomHashMap<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.Short>
    
    Overrides:
    
    clear in class Object2ShortOpenCustomHashMap<T>

Class Object2ShortLinkedOpenCustomHashMap<T>

Nested Class Summary

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

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

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

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

Constructor Summary

Method Summary

Methods inherited from class speiger.src.collections.objects.maps.impl.customHash.Object2ShortOpenCustomHashMap

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

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

Methods inherited from interface java.util.Map

Constructor Detail

Object2ShortLinkedOpenCustomHashMap

Object2ShortLinkedOpenCustomHashMap

Object2ShortLinkedOpenCustomHashMap

Object2ShortLinkedOpenCustomHashMap

Object2ShortLinkedOpenCustomHashMap

Object2ShortLinkedOpenCustomHashMap

Object2ShortLinkedOpenCustomHashMap

Object2ShortLinkedOpenCustomHashMap

Object2ShortLinkedOpenCustomHashMap

Object2ShortLinkedOpenCustomHashMap

Object2ShortLinkedOpenCustomHashMap

Method Detail

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

comparator

subMap

headMap

tailMap

firstKey

pollFirstKey

lastKey

pollLastKey

firstShortValue

lastShortValue

object2ShortEntrySet

keySet

values

forEach

clear