speiger.src.collections.objects.maps.impl.customHash

Class Object2ObjectLinkedOpenCustomHashMap<T,V>

java.lang.Object

java.util.AbstractMap<T,V>

speiger.src.collections.objects.maps.abstracts.AbstractObject2ObjectMap<T,V>

speiger.src.collections.objects.maps.impl.customHash.Object2ObjectOpenCustomHashMap<T,V>

speiger.src.collections.objects.maps.impl.customHash.Object2ObjectLinkedOpenCustomHashMap<T,V>

Type Parameters:

T - the keyType of elements maintained by this Collection

V - the keyType of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.Function<T,V>, java.util.Map<T,V>, UnaryOperator<T,V>, Object2ObjectMap<T,V>, Object2ObjectOrderedMap<T,V>, ITrimmable

public class Object2ObjectLinkedOpenCustomHashMap<T,V>
extends Object2ObjectOpenCustomHashMap<T,V>
implements Object2ObjectOrderedMap<T,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.objects.maps.abstracts.AbstractObject2ObjectMap

AbstractObject2ObjectMap.BasicEntry<T,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.objects.maps.interfaces.Object2ObjectOrderedMap

Object2ObjectOrderedMap.FastOrderedSet<T,V>

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

Object2ObjectMap.BuilderCache<T,V>, Object2ObjectMap.Entry<T,V>, Object2ObjectMap.FastEntrySet<T,V>, Object2ObjectMap.MapBuilder

Constructor Summary

Constructors

Constructor and Description
Object2ObjectLinkedOpenCustomHashMap(int minCapacity, float loadFactor, ObjectStrategy<? super T> strategy) Constructor that defines the minimum capacity and load factor
Object2ObjectLinkedOpenCustomHashMap(int minCapacity, ObjectStrategy<? super T> strategy) Constructor that defines the minimum capacity
Object2ObjectLinkedOpenCustomHashMap(java.util.Map<? extends T,? extends V> 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.
Object2ObjectLinkedOpenCustomHashMap(java.util.Map<? extends T,? extends V> map, ObjectStrategy<? super T> strategy) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Object2ObjectLinkedOpenCustomHashMap(Object2ObjectMap<T,V> 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.
Object2ObjectLinkedOpenCustomHashMap(Object2ObjectMap<T,V> 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.
Object2ObjectLinkedOpenCustomHashMap(ObjectStrategy<? super T> strategy) Default Constructor
Object2ObjectLinkedOpenCustomHashMap(T[] keys, V[] values, float loadFactor, ObjectStrategy<? super T> strategy) Helper constructor that allow to create a map from unboxed values
Object2ObjectLinkedOpenCustomHashMap(T[] keys, V[] values, ObjectStrategy<? super T> strategy) Helper constructor that allow to create a map from unboxed values

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
Object2ObjectLinkedOpenCustomHashMap<T,V>	copy() A Function that does a shallow clone of the Map itself.
T	firstKey() A method to get the first Key of a Map.
V	firstValue() A method to get the first Value of a Map.
void	forEach(ObjectObjectConsumer<T,V> action) Type Specific forEach method to reduce boxing/unboxing
V	getAndMoveToFirst(T key) A Specific get method that allows to move teh given key/value int the first index.
V	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.
V	lastValue() 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<Object2ObjectMap.Entry<T,V>>	object2ObjectEntrySet() 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.
V	putAndMoveToFirst(T key, V value) A customized put method that allows you to insert into the first index.
V	putAndMoveToLast(T 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.objects.maps.impl.customHash.Object2ObjectOpenCustomHashMap

compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, get, getObject, getOrDefault, merge, mergeAll, put, putIfAbsent, rem, remOrDefault, remove, remove, replace, replace, size, supplyIfAbsent, trim

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

entrySet, equals, getDefaultReturnValue, hashCode, 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.objects.maps.interfaces.Object2ObjectOrderedMap

synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2ObjectMap

apply, builder, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, entrySet, forEach, getDefaultReturnValue, getObject, merge, merge, mergeAll, put, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, rem, remOrDefault, remove, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue, supplyIfAbsent

Methods inherited from interface java.util.Map

containsKey, containsValue, equals, get, getOrDefault, hashCode, isEmpty, putAll, remove, size

Methods inherited from interface speiger.src.collections.objects.functions.function.UnaryOperator

andThen, compose, identity

Methods inherited from interface java.util.function.Function

andThen, compose

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

clearAndTrim, trim

Constructor Detail

Object2ObjectLinkedOpenCustomHashMap

public Object2ObjectLinkedOpenCustomHashMap(ObjectStrategy<? super T> strategy)

Default Constructor

Parameters:

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

Object2ObjectLinkedOpenCustomHashMap

public Object2ObjectLinkedOpenCustomHashMap(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

Object2ObjectLinkedOpenCustomHashMap

public Object2ObjectLinkedOpenCustomHashMap(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

Object2ObjectLinkedOpenCustomHashMap

public Object2ObjectLinkedOpenCustomHashMap(T[] keys,
                                            V[] 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

Object2ObjectLinkedOpenCustomHashMap

public Object2ObjectLinkedOpenCustomHashMap(T[] keys,
                                            V[] 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

Object2ObjectLinkedOpenCustomHashMap

public Object2ObjectLinkedOpenCustomHashMap(java.util.Map<? extends T,? extends V> 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

Object2ObjectLinkedOpenCustomHashMap

public Object2ObjectLinkedOpenCustomHashMap(java.util.Map<? extends T,? extends V> 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

Object2ObjectLinkedOpenCustomHashMap

public Object2ObjectLinkedOpenCustomHashMap(Object2ObjectMap<T,V> 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

Object2ObjectLinkedOpenCustomHashMap

public Object2ObjectLinkedOpenCustomHashMap(Object2ObjectMap<T,V> 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 V putAndMoveToFirst(T key,
                           V value)

Description copied from interface: Object2ObjectOrderedMap

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

Specified by:

putAndMoveToFirst in interface Object2ObjectOrderedMap<T,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(T key,
                          V value)

Description copied from interface: Object2ObjectOrderedMap

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 Object2ObjectOrderedMap<T,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(T key)

Description copied from interface: Object2ObjectOrderedMap

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

Specified by:

moveToFirst in interface Object2ObjectOrderedMap<T,V>

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

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

Specified by:

moveToLast in interface Object2ObjectOrderedMap<T,V>

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public V getAndMoveToFirst(T key)

Description copied from interface: Object2ObjectOrderedMap

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

Specified by:

getAndMoveToFirst in interface Object2ObjectOrderedMap<T,V>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public V getAndMoveToLast(T key)

Description copied from interface: Object2ObjectOrderedMap

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

Specified by:

getAndMoveToLast in interface Object2ObjectOrderedMap<T,V>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

copy

public Object2ObjectLinkedOpenCustomHashMap<T,V> copy()

Description copied from interface: Object2ObjectMap

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 Object2ObjectMap<T,V>

Specified by:

copy in interface Object2ObjectOrderedMap<T,V>

Overrides:

copy in class Object2ObjectOpenCustomHashMap<T,V>

Returns:

a Shallow Copy of the Map

firstKey

public T firstKey()

Description copied from interface: Object2ObjectOrderedMap

A method to get the first Key of a Map.

Specified by:

firstKey in interface Object2ObjectOrderedMap<T,V>

Returns:

the first key in the map

pollFirstKey

public T pollFirstKey()

Description copied from interface: Object2ObjectOrderedMap

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

Specified by:

pollFirstKey in interface Object2ObjectOrderedMap<T,V>

Returns:

the first key in the map

lastKey

public T lastKey()

Description copied from interface: Object2ObjectOrderedMap

A method to get the last Key of a Map.

Specified by:

lastKey in interface Object2ObjectOrderedMap<T,V>

Returns:

the last key in the map

pollLastKey

public T pollLastKey()

Description copied from interface: Object2ObjectOrderedMap

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

Specified by:

pollLastKey in interface Object2ObjectOrderedMap<T,V>

Returns:

the last key in the map

firstValue

public V firstValue()

Description copied from interface: Object2ObjectOrderedMap

A method to get the first Value of a Map.

Specified by:

firstValue in interface Object2ObjectOrderedMap<T,V>

Returns:

the first key in the map

lastValue

public V lastValue()

Description copied from interface: Object2ObjectOrderedMap

A method to get the last Value of a Map.

Specified by:

lastValue in interface Object2ObjectOrderedMap<T,V>

Returns:

the last key in the map

object2ObjectEntrySet

public ObjectOrderedSet<Object2ObjectMap.Entry<T,V>> object2ObjectEntrySet()

Description copied from interface: Object2ObjectMap

Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.

Specified by:

object2ObjectEntrySet in interface Object2ObjectMap<T,V>

Specified by:

object2ObjectEntrySet in interface Object2ObjectOrderedMap<T,V>

Overrides:

object2ObjectEntrySet in class Object2ObjectOpenCustomHashMap<T,V>

Returns:

a EntrySet of the collection

keySet

public ObjectOrderedSet<T> keySet()

Specified by:

keySet in interface java.util.Map<T,V>

Specified by:

keySet in interface Object2ObjectMap<T,V>

Specified by:

keySet in interface Object2ObjectOrderedMap<T,V>

Overrides:

keySet in class Object2ObjectOpenCustomHashMap<T,V>

values

public ObjectCollection<V> values()

Specified by:

values in interface java.util.Map<T,V>

Specified by:

values in interface Object2ObjectMap<T,V>

Overrides:

values in class Object2ObjectOpenCustomHashMap<T,V>

forEach

public void forEach(ObjectObjectConsumer<T,V> action)

Description copied from interface: Object2ObjectMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Object2ObjectMap<T,V>

Overrides:

forEach in class Object2ObjectOpenCustomHashMap<T,V>

Parameters:

action - processor of the values that are iterator over

clear

public void clear()

Specified by:

clear in interface java.util.Map<T,V>

Overrides:

clear in class Object2ObjectOpenCustomHashMap<T,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 Object2ObjectOpenCustomHashMap<T,V>

Parameters:

size - the amount of elements that should be allowed