Short2ObjectLinkedOpenCustomHashMap (Primitive-Collections 0.8.0 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Short,V>
- - speiger.src.collections.shorts.maps.abstracts.AbstractShort2ObjectMap<V>
  - - speiger.src.collections.shorts.maps.impl.customHash.Short2ObjectOpenCustomHashMap<V>
    - - speiger.src.collections.shorts.maps.impl.customHash.Short2ObjectLinkedOpenCustomHashMap<V>

Type Parameters:

V - the keyType of elements maintained by this Collection

All Implemented Interfaces:

java.util.Map<java.lang.Short,V>, ShortFunction<V>, Short2ObjectMap<V>, Short2ObjectOrderedMap<V>, ITrimmable
```
public class Short2ObjectLinkedOpenCustomHashMap<V>
extends Short2ObjectOpenCustomHashMap<V>
implements Short2ObjectOrderedMap<V>
```
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.shorts.maps.abstracts.AbstractShort2ObjectMap
  AbstractShort2ObjectMap.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.shorts.maps.interfaces.Short2ObjectOrderedMap
  Short2ObjectOrderedMap.FastOrderedSet<V>
- Nested classes/interfaces inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2ObjectMap
  Short2ObjectMap.BuilderCache<V>, Short2ObjectMap.Entry<V>, Short2ObjectMap.FastEntrySet<V>, Short2ObjectMap.MapBuilder

Constructor Summary

Constructors
Constructor and Description
`Short2ObjectLinkedOpenCustomHashMap(int minCapacity, float loadFactor, ShortStrategy strategy)` Constructor that defines the minimum capacity and load factor
`Short2ObjectLinkedOpenCustomHashMap(int minCapacity, ShortStrategy strategy)` Constructor that defines the minimum capacity
`Short2ObjectLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Short,? extends V> map, float loadFactor, ShortStrategy strategy)` A Helper constructor that allows to create a Map with exactly the same values as the provided map.
`Short2ObjectLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Short,? extends V> map, ShortStrategy strategy)` A Helper constructor that allows to create a Map with exactly the same values as the provided map.
`Short2ObjectLinkedOpenCustomHashMap(short[] keys, V[] values, float loadFactor, ShortStrategy strategy)` Helper constructor that allow to create a map from unboxed values
`Short2ObjectLinkedOpenCustomHashMap(java.lang.Short[] keys, V[] values, float loadFactor, ShortStrategy strategy)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`Short2ObjectLinkedOpenCustomHashMap(short[] keys, V[] values, ShortStrategy strategy)` Helper constructor that allow to create a map from unboxed values
`Short2ObjectLinkedOpenCustomHashMap(java.lang.Short[] keys, V[] values, ShortStrategy strategy)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`Short2ObjectLinkedOpenCustomHashMap(Short2ObjectMap<V> map, float loadFactor, ShortStrategy strategy)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`Short2ObjectLinkedOpenCustomHashMap(Short2ObjectMap<V> map, ShortStrategy strategy)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`Short2ObjectLinkedOpenCustomHashMap(ShortStrategy strategy)` Default Constructor

Method Summary

All Methods Instance Methods Concrete 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
`Short2ObjectLinkedOpenCustomHashMap<V>`	`copy()` A Function that does a shallow clone of the Map itself.
`short`	`firstShortKey()` A method to get the first Key of a Map.
`V`	`firstValue()` A method to get the first Value of a Map.
`void`	`forEach(ShortObjectConsumer<V> action)` Type Specific forEach method to reduce boxing/unboxing
`V`	`getAndMoveToFirst(short key)` A Specific get method that allows to move teh given key/value int the first index.
`V`	`getAndMoveToLast(short key)` A Specific get method that allows to move teh given key/value int the last index.
`ShortOrderedSet`	`keySet()`
`short`	`lastShortKey()` A method to get the last Key of a Map.
`V`	`lastValue()` A method to get the last Value of a Map.
`boolean`	`moveToFirst(short key)` A specific move method to move a given key/value to the first index.
`boolean`	`moveToLast(short key)` A specific move method to move a given key/value to the last index.
`short`	`pollFirstShortKey()` A method to get and remove the first Key of a Map.
`short`	`pollLastShortKey()` A method to get and remove the last Key of a Map.
`V`	`putAndMoveToFirst(short key, V value)` A customized put method that allows you to insert into the first index.
`V`	`putAndMoveToLast(short key, V value)` A customized put method that allows you to insert into the last index.
`ObjectOrderedSet<Short2ObjectMap.Entry<V>>`	`short2ObjectEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`ObjectCollection<V>`	`values()`

Methods inherited from class speiger.src.collections.shorts.maps.impl.customHash.Short2ObjectOpenCustomHashMap
compute, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, get, get, getOrDefault, merge, mergeAll, put, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, size, supplyIfAbsent, trim

Methods inherited from class speiger.src.collections.shorts.maps.abstracts.AbstractShort2ObjectMap
entrySet, equals, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, replaceObjects, replaceObjects, 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.shorts.maps.interfaces.Short2ObjectOrderedMap
synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2ObjectMap
apply, builder, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, entrySet, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, merge, mergeAll, put, put, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue, supplyIfAbsent

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

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

- Constructor Detail
  - Short2ObjectLinkedOpenCustomHashMap
```
public Short2ObjectLinkedOpenCustomHashMap(ShortStrategy strategy)
```
    Default Constructor
    
    Parameters:
    
    strategy - the strategy that allows hash control.
    
    Throws:
    
    java.lang.NullPointerException - if Strategy is null
  - Short2ObjectLinkedOpenCustomHashMap
```
public Short2ObjectLinkedOpenCustomHashMap(int minCapacity,
                                           ShortStrategy 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
  - Short2ObjectLinkedOpenCustomHashMap
```
public Short2ObjectLinkedOpenCustomHashMap(int minCapacity,
                                           float loadFactor,
                                           ShortStrategy 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
  - Short2ObjectLinkedOpenCustomHashMap
```
public Short2ObjectLinkedOpenCustomHashMap(java.lang.Short[] keys,
                                           V[] values,
                                           ShortStrategy 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
  - Short2ObjectLinkedOpenCustomHashMap
```
public Short2ObjectLinkedOpenCustomHashMap(java.lang.Short[] keys,
                                           V[] values,
                                           float loadFactor,
                                           ShortStrategy 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
  - Short2ObjectLinkedOpenCustomHashMap
```
public Short2ObjectLinkedOpenCustomHashMap(short[] keys,
                                           V[] values,
                                           ShortStrategy 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
  - Short2ObjectLinkedOpenCustomHashMap
```
public Short2ObjectLinkedOpenCustomHashMap(short[] keys,
                                           V[] values,
                                           float loadFactor,
                                           ShortStrategy 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
  - Short2ObjectLinkedOpenCustomHashMap
```
public Short2ObjectLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Short,? extends V> map,
                                           ShortStrategy 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
  - Short2ObjectLinkedOpenCustomHashMap
```
public Short2ObjectLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Short,? extends V> map,
                                           float loadFactor,
                                           ShortStrategy 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
  - Short2ObjectLinkedOpenCustomHashMap
```
public Short2ObjectLinkedOpenCustomHashMap(Short2ObjectMap<V> map,
                                           ShortStrategy 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
  - Short2ObjectLinkedOpenCustomHashMap
```
public Short2ObjectLinkedOpenCustomHashMap(Short2ObjectMap<V> map,
                                           float loadFactor,
                                           ShortStrategy 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 V putAndMoveToFirst(short key,
                           V value)
```
    Description copied from interface: Short2ObjectOrderedMap
    
    A customized put method that allows you to insert into the first index.
    
    Specified by:
    
    putAndMoveToFirst in interface Short2ObjectOrderedMap<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(short key,
                          V value)
```
    Description copied from interface: Short2ObjectOrderedMap
    
    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 Short2ObjectOrderedMap<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(short key)
```
    Description copied from interface: Short2ObjectOrderedMap
    
    A specific move method to move a given key/value to the first index.
    
    Specified by:
    
    moveToFirst in interface Short2ObjectOrderedMap<V>
    
    Parameters:
    
    key - that should be moved to the first index
    
    Returns:
    
    true if the value was moved.
  - moveToLast
```
public boolean moveToLast(short key)
```
    Description copied from interface: Short2ObjectOrderedMap
    
    A specific move method to move a given key/value to the last index.
    
    Specified by:
    
    moveToLast in interface Short2ObjectOrderedMap<V>
    
    Parameters:
    
    key - that should be moved to the first last
    
    Returns:
    
    true if the value was moved.
  - getAndMoveToFirst
```
public V getAndMoveToFirst(short key)
```
    Description copied from interface: Short2ObjectOrderedMap
    
    A Specific get method that allows to move teh given key/value int the first index.
    
    Specified by:
    
    getAndMoveToFirst in interface Short2ObjectOrderedMap<V>
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - getAndMoveToLast
```
public V getAndMoveToLast(short key)
```
    Description copied from interface: Short2ObjectOrderedMap
    
    A Specific get method that allows to move teh given key/value int the last index.
    
    Specified by:
    
    getAndMoveToLast in interface Short2ObjectOrderedMap<V>
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - copy
```
public Short2ObjectLinkedOpenCustomHashMap<V> copy()
```
    Description copied from interface: Short2ObjectMap
    
    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 Short2ObjectMap<V>
    
    Specified by:
    
    copy in interface Short2ObjectOrderedMap<V>
    
    Overrides:
    
    copy in class Short2ObjectOpenCustomHashMap<V>
    
    Returns:
    
    a Shallow Copy of the Map
  - firstShortKey
```
public short firstShortKey()
```
    Description copied from interface: Short2ObjectOrderedMap
    
    A method to get the first Key of a Map.
    
    Specified by:
    
    firstShortKey in interface Short2ObjectOrderedMap<V>
    
    Returns:
    
    the first key in the map
  - pollFirstShortKey
```
public short pollFirstShortKey()
```
    Description copied from interface: Short2ObjectOrderedMap
    
    A method to get and remove the first Key of a Map.
    
    Specified by:
    
    pollFirstShortKey in interface Short2ObjectOrderedMap<V>
    
    Returns:
    
    the first key in the map
  - lastShortKey
```
public short lastShortKey()
```
    Description copied from interface: Short2ObjectOrderedMap
    
    A method to get the last Key of a Map.
    
    Specified by:
    
    lastShortKey in interface Short2ObjectOrderedMap<V>
    
    Returns:
    
    the last key in the map
  - pollLastShortKey
```
public short pollLastShortKey()
```
    Description copied from interface: Short2ObjectOrderedMap
    
    A method to get and remove the last Key of a Map.
    
    Specified by:
    
    pollLastShortKey in interface Short2ObjectOrderedMap<V>
    
    Returns:
    
    the last key in the map
  - firstValue
```
public V firstValue()
```
    Description copied from interface: Short2ObjectOrderedMap
    
    A method to get the first Value of a Map.
    
    Specified by:
    
    firstValue in interface Short2ObjectOrderedMap<V>
    
    Returns:
    
    the first key in the map
  - lastValue
```
public V lastValue()
```
    Description copied from interface: Short2ObjectOrderedMap
    
    A method to get the last Value of a Map.
    
    Specified by:
    
    lastValue in interface Short2ObjectOrderedMap<V>
    
    Returns:
    
    the last key in the map
  - short2ObjectEntrySet
```
public ObjectOrderedSet<Short2ObjectMap.Entry<V>> short2ObjectEntrySet()
```
    Description copied from interface: Short2ObjectMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Specified by:
    
    short2ObjectEntrySet in interface Short2ObjectMap<V>
    
    Specified by:
    
    short2ObjectEntrySet in interface Short2ObjectOrderedMap<V>
    
    Overrides:
    
    short2ObjectEntrySet in class Short2ObjectOpenCustomHashMap<V>
    
    Returns:
    
    a EntrySet of the collection
  - keySet
```
public ShortOrderedSet keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Short,V>
    
    Specified by:
    
    keySet in interface Short2ObjectMap<V>
    
    Specified by:
    
    keySet in interface Short2ObjectOrderedMap<V>
    
    Overrides:
    
    keySet in class Short2ObjectOpenCustomHashMap<V>
  - values
```
public ObjectCollection<V> values()
```
    Specified by:
    
    values in interface java.util.Map<java.lang.Short,V>
    
    Specified by:
    
    values in interface Short2ObjectMap<V>
    
    Overrides:
    
    values in class Short2ObjectOpenCustomHashMap<V>
  - forEach
```
public void forEach(ShortObjectConsumer<V> action)
```
    Description copied from interface: Short2ObjectMap
    
    Type Specific forEach method to reduce boxing/unboxing
    
    Specified by:
    
    forEach in interface Short2ObjectMap<V>
    
    Overrides:
    
    forEach in class Short2ObjectOpenCustomHashMap<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.Short,V>
    
    Overrides:
    
    clear in class Short2ObjectOpenCustomHashMap<V>
  - 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 Short2ObjectOpenCustomHashMap<V>
    
    Parameters:
    
    size - the amount of elements that should be allowed

Class Short2ObjectLinkedOpenCustomHashMap<V>

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.shorts.maps.abstracts.AbstractShort2ObjectMap

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

Nested classes/interfaces inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2ObjectOrderedMap

Nested classes/interfaces inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2ObjectMap

Constructor Summary

Method Summary

Methods inherited from class speiger.src.collections.shorts.maps.impl.customHash.Short2ObjectOpenCustomHashMap

Methods inherited from class speiger.src.collections.shorts.maps.abstracts.AbstractShort2ObjectMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2ObjectOrderedMap

Methods inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2ObjectMap

Methods inherited from interface java.util.Map

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

Constructor Detail

Short2ObjectLinkedOpenCustomHashMap

Short2ObjectLinkedOpenCustomHashMap

Short2ObjectLinkedOpenCustomHashMap

Short2ObjectLinkedOpenCustomHashMap

Short2ObjectLinkedOpenCustomHashMap

Short2ObjectLinkedOpenCustomHashMap

Short2ObjectLinkedOpenCustomHashMap

Short2ObjectLinkedOpenCustomHashMap

Short2ObjectLinkedOpenCustomHashMap

Short2ObjectLinkedOpenCustomHashMap

Short2ObjectLinkedOpenCustomHashMap

Method Detail

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

copy

firstShortKey

pollFirstShortKey

lastShortKey

pollLastShortKey

firstValue

lastValue

short2ObjectEntrySet

keySet

values

forEach

clear

clearAndTrim