speiger.src.collections.ints.maps.impl.customHash

Class Int2ObjectLinkedOpenCustomHashMap<V>

java.lang.Object

java.util.AbstractMap<java.lang.Integer,V>

speiger.src.collections.ints.maps.abstracts.AbstractInt2ObjectMap<V>

speiger.src.collections.ints.maps.impl.customHash.Int2ObjectOpenCustomHashMap<V>

speiger.src.collections.ints.maps.impl.customHash.Int2ObjectLinkedOpenCustomHashMap<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>, Int2ObjectFunction<V>, Int2ObjectMap<V>, Int2ObjectOrderedMap<V>, ITrimmable

public class Int2ObjectLinkedOpenCustomHashMap<V>
extends Int2ObjectOpenCustomHashMap<V>
implements Int2ObjectOrderedMap<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.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.Int2ObjectOrderedMap

Int2ObjectOrderedMap.FastOrderedSet<V>

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

Int2ObjectMap.BuilderCache<V>, Int2ObjectMap.Entry<V>, Int2ObjectMap.FastEntrySet<V>, Int2ObjectMap.MapBuilder

Constructor Summary

Constructors

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

Method Summary

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
Int2ObjectLinkedOpenCustomHashMap<V>	copy() A Function that does a shallow clone of the Map itself.
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.
ObjectOrderedSet<Int2ObjectMap.Entry<V>>	int2ObjectEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
IntOrderedSet	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.
ObjectCollection<V>	values()

Methods inherited from class speiger.src.collections.ints.maps.impl.customHash.Int2ObjectOpenCustomHashMap

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.ints.maps.abstracts.AbstractInt2ObjectMap

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.ints.maps.interfaces.Int2ObjectOrderedMap

synchronize, synchronize, unmodifiable

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

builder, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, entrySet, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, merge, mergeAll, 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.ints.functions.function.Int2ObjectFunction

apply

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

clearAndTrim, trim

Constructor Detail

Int2ObjectLinkedOpenCustomHashMap

public Int2ObjectLinkedOpenCustomHashMap(IntStrategy strategy)

Default Constructor

Parameters:

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

Int2ObjectLinkedOpenCustomHashMap

public Int2ObjectLinkedOpenCustomHashMap(int minCapacity,
                                         IntStrategy 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

Int2ObjectLinkedOpenCustomHashMap

public Int2ObjectLinkedOpenCustomHashMap(int minCapacity,
                                         float loadFactor,
                                         IntStrategy 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

Int2ObjectLinkedOpenCustomHashMap

public Int2ObjectLinkedOpenCustomHashMap(java.lang.Integer[] keys,
                                         V[] values,
                                         IntStrategy 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

Int2ObjectLinkedOpenCustomHashMap

public Int2ObjectLinkedOpenCustomHashMap(java.lang.Integer[] keys,
                                         V[] values,
                                         float loadFactor,
                                         IntStrategy 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

Int2ObjectLinkedOpenCustomHashMap

public Int2ObjectLinkedOpenCustomHashMap(int[] keys,
                                         V[] values,
                                         IntStrategy 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

Int2ObjectLinkedOpenCustomHashMap

public Int2ObjectLinkedOpenCustomHashMap(int[] keys,
                                         V[] values,
                                         float loadFactor,
                                         IntStrategy 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

Int2ObjectLinkedOpenCustomHashMap

public Int2ObjectLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Integer,? extends V> map,
                                         IntStrategy 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

Int2ObjectLinkedOpenCustomHashMap

public Int2ObjectLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Integer,? extends V> map,
                                         float loadFactor,
                                         IntStrategy 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

Int2ObjectLinkedOpenCustomHashMap

public Int2ObjectLinkedOpenCustomHashMap(Int2ObjectMap<V> map,
                                         IntStrategy 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

Int2ObjectLinkedOpenCustomHashMap

public Int2ObjectLinkedOpenCustomHashMap(Int2ObjectMap<V> map,
                                         float loadFactor,
                                         IntStrategy 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(int key,
                           V value)

Description copied from interface: Int2ObjectOrderedMap

A customized put method that allows you to insert into the first index.

Specified by:

putAndMoveToFirst in interface Int2ObjectOrderedMap<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: Int2ObjectOrderedMap

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 Int2ObjectOrderedMap<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: Int2ObjectOrderedMap

A specific move method to move a given key/value to the first index.

Specified by:

moveToFirst in interface Int2ObjectOrderedMap<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: Int2ObjectOrderedMap

A specific move method to move a given key/value to the last index.

Specified by:

moveToLast in interface Int2ObjectOrderedMap<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: Int2ObjectOrderedMap

A Specific get method that allows to move teh given key/value int the first index.

Specified by:

getAndMoveToFirst in interface Int2ObjectOrderedMap<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: Int2ObjectOrderedMap

A Specific get method that allows to move teh given key/value int the last index.

Specified by:

getAndMoveToLast in interface Int2ObjectOrderedMap<V>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

copy

public Int2ObjectLinkedOpenCustomHashMap<V> copy()

Description copied from interface: Int2ObjectMap

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 Int2ObjectMap<V>

Specified by:

copy in interface Int2ObjectOrderedMap<V>

Overrides:

copy in class Int2ObjectOpenCustomHashMap<V>

Returns:

a Shallow Copy of the Map

firstIntKey

public int firstIntKey()

Description copied from interface: Int2ObjectOrderedMap

A method to get the first Key of a Map.

Specified by:

firstIntKey in interface Int2ObjectOrderedMap<V>

Returns:

the first key in the map

pollFirstIntKey

public int pollFirstIntKey()

Description copied from interface: Int2ObjectOrderedMap

A method to get and remove the first Key of a Map.

Specified by:

pollFirstIntKey in interface Int2ObjectOrderedMap<V>

Returns:

the first key in the map

lastIntKey

public int lastIntKey()

Description copied from interface: Int2ObjectOrderedMap

A method to get the last Key of a Map.

Specified by:

lastIntKey in interface Int2ObjectOrderedMap<V>

Returns:

the last key in the map

pollLastIntKey

public int pollLastIntKey()

Description copied from interface: Int2ObjectOrderedMap

A method to get and remove the last Key of a Map.

Specified by:

pollLastIntKey in interface Int2ObjectOrderedMap<V>

Returns:

the last key in the map

firstValue

public V firstValue()

Description copied from interface: Int2ObjectOrderedMap

A method to get the first Value of a Map.

Specified by:

firstValue in interface Int2ObjectOrderedMap<V>

Returns:

the first key in the map

lastValue

public V lastValue()

Description copied from interface: Int2ObjectOrderedMap

A method to get the last Value of a Map.

Specified by:

lastValue in interface Int2ObjectOrderedMap<V>

Returns:

the last key in the map

int2ObjectEntrySet

public ObjectOrderedSet<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>

Specified by:

int2ObjectEntrySet in interface Int2ObjectOrderedMap<V>

Overrides:

int2ObjectEntrySet in class Int2ObjectOpenCustomHashMap<V>

Returns:

a EntrySet of the collection

keySet

public IntOrderedSet keySet()

Specified by:

keySet in interface java.util.Map<java.lang.Integer,V>

Specified by:

keySet in interface Int2ObjectMap<V>

Specified by:

keySet in interface Int2ObjectOrderedMap<V>

Overrides:

keySet in class Int2ObjectOpenCustomHashMap<V>

values

public ObjectCollection<V> values()

Specified by:

values in interface java.util.Map<java.lang.Integer,V>

Specified by:

values in interface Int2ObjectMap<V>

Overrides:

values in class Int2ObjectOpenCustomHashMap<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 Int2ObjectOpenCustomHashMap<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 Int2ObjectOpenCustomHashMap<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 Int2ObjectOpenCustomHashMap<V>

Parameters:

size - the amount of elements that should be allowed