speiger.src.collections.floats.maps.impl.customHash

Class Float2ObjectLinkedOpenCustomHashMap<V>

java.lang.Object

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

speiger.src.collections.floats.maps.abstracts.AbstractFloat2ObjectMap<V>

speiger.src.collections.floats.maps.impl.customHash.Float2ObjectOpenCustomHashMap<V>

speiger.src.collections.floats.maps.impl.customHash.Float2ObjectLinkedOpenCustomHashMap<V>

Type Parameters:

V - the keyType of elements maintained by this Collection

All Implemented Interfaces:

java.util.Map<java.lang.Float,V>, FloatFunction<V>, Float2ObjectMap<V>, Float2ObjectOrderedMap<V>, ITrimmable

public class Float2ObjectLinkedOpenCustomHashMap<V>
extends Float2ObjectOpenCustomHashMap<V>
implements Float2ObjectOrderedMap<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.floats.maps.abstracts.AbstractFloat2ObjectMap

AbstractFloat2ObjectMap.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.floats.maps.interfaces.Float2ObjectOrderedMap

Float2ObjectOrderedMap.FastOrderedSet<V>

Nested classes/interfaces inherited from interface speiger.src.collections.floats.maps.interfaces.Float2ObjectMap

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

Constructor Summary

Constructors

Constructor and Description
Float2ObjectLinkedOpenCustomHashMap(float[] keys, V[] values, float loadFactor, FloatStrategy strategy) Helper constructor that allow to create a map from unboxed values
Float2ObjectLinkedOpenCustomHashMap(java.lang.Float[] keys, V[] values, float loadFactor, FloatStrategy strategy) Helper constructor that allow to create a map from boxed values (it will unbox them)
Float2ObjectLinkedOpenCustomHashMap(float[] keys, V[] values, FloatStrategy strategy) Helper constructor that allow to create a map from unboxed values
Float2ObjectLinkedOpenCustomHashMap(java.lang.Float[] keys, V[] values, FloatStrategy strategy) Helper constructor that allow to create a map from boxed values (it will unbox them)
Float2ObjectLinkedOpenCustomHashMap(Float2ObjectMap<V> map, float loadFactor, FloatStrategy strategy) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Float2ObjectLinkedOpenCustomHashMap(Float2ObjectMap<V> map, FloatStrategy strategy) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Float2ObjectLinkedOpenCustomHashMap(FloatStrategy strategy) Default Constructor
Float2ObjectLinkedOpenCustomHashMap(int minCapacity, float loadFactor, FloatStrategy strategy) Constructor that defines the minimum capacity and load factor
Float2ObjectLinkedOpenCustomHashMap(int minCapacity, FloatStrategy strategy) Constructor that defines the minimum capacity
Float2ObjectLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Float,? extends V> map, float loadFactor, FloatStrategy strategy) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Float2ObjectLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Float,? extends V> map, FloatStrategy 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
Float2ObjectLinkedOpenCustomHashMap<V>	copy() A Function that does a shallow clone of the Map itself.
float	firstFloatKey() A method to get the first Key of a Map.
V	firstValue() A method to get the first Value of a Map.
ObjectOrderedSet<Float2ObjectMap.Entry<V>>	float2ObjectEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
void	forEach(FloatObjectConsumer<V> action) Type Specific forEach method to reduce boxing/unboxing
V	getAndMoveToFirst(float key) A Specific get method that allows to move teh given key/value int the first index.
V	getAndMoveToLast(float key) A Specific get method that allows to move teh given key/value int the last index.
FloatOrderedSet	keySet()
float	lastFloatKey() A method to get the last Key of a Map.
V	lastValue() A method to get the last Value of a Map.
boolean	moveToFirst(float key) A specific move method to move a given key/value to the first index.
boolean	moveToLast(float key) A specific move method to move a given key/value to the last index.
float	pollFirstFloatKey() A method to get and remove the first Key of a Map.
float	pollLastFloatKey() A method to get and remove the last Key of a Map.
V	putAndMoveToFirst(float key, V value) A customized put method that allows you to insert into the first index.
V	putAndMoveToLast(float 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.floats.maps.impl.customHash.Float2ObjectOpenCustomHashMap

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.floats.maps.abstracts.AbstractFloat2ObjectMap

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.floats.maps.interfaces.Float2ObjectOrderedMap

synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.floats.maps.interfaces.Float2ObjectMap

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

Float2ObjectLinkedOpenCustomHashMap

public Float2ObjectLinkedOpenCustomHashMap(FloatStrategy strategy)

Default Constructor

Parameters:

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

Float2ObjectLinkedOpenCustomHashMap

public Float2ObjectLinkedOpenCustomHashMap(int minCapacity,
                                           FloatStrategy 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

Float2ObjectLinkedOpenCustomHashMap

public Float2ObjectLinkedOpenCustomHashMap(int minCapacity,
                                           float loadFactor,
                                           FloatStrategy 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

Float2ObjectLinkedOpenCustomHashMap

public Float2ObjectLinkedOpenCustomHashMap(java.lang.Float[] keys,
                                           V[] values,
                                           FloatStrategy 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

Float2ObjectLinkedOpenCustomHashMap

public Float2ObjectLinkedOpenCustomHashMap(java.lang.Float[] keys,
                                           V[] values,
                                           float loadFactor,
                                           FloatStrategy 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

Float2ObjectLinkedOpenCustomHashMap

public Float2ObjectLinkedOpenCustomHashMap(float[] keys,
                                           V[] values,
                                           FloatStrategy 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

Float2ObjectLinkedOpenCustomHashMap

public Float2ObjectLinkedOpenCustomHashMap(float[] keys,
                                           V[] values,
                                           float loadFactor,
                                           FloatStrategy 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

Float2ObjectLinkedOpenCustomHashMap

public Float2ObjectLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Float,? extends V> map,
                                           FloatStrategy 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

Float2ObjectLinkedOpenCustomHashMap

public Float2ObjectLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Float,? extends V> map,
                                           float loadFactor,
                                           FloatStrategy 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

Float2ObjectLinkedOpenCustomHashMap

public Float2ObjectLinkedOpenCustomHashMap(Float2ObjectMap<V> map,
                                           FloatStrategy 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

Float2ObjectLinkedOpenCustomHashMap

public Float2ObjectLinkedOpenCustomHashMap(Float2ObjectMap<V> map,
                                           float loadFactor,
                                           FloatStrategy 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(float key,
                           V value)

Description copied from interface: Float2ObjectOrderedMap

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

Specified by:

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

Description copied from interface: Float2ObjectOrderedMap

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 Float2ObjectOrderedMap<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(float key)

Description copied from interface: Float2ObjectOrderedMap

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

Specified by:

moveToFirst in interface Float2ObjectOrderedMap<V>

Parameters:

key - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(float key)

Description copied from interface: Float2ObjectOrderedMap

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

Specified by:

moveToLast in interface Float2ObjectOrderedMap<V>

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public V getAndMoveToFirst(float key)

Description copied from interface: Float2ObjectOrderedMap

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

Specified by:

getAndMoveToFirst in interface Float2ObjectOrderedMap<V>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public V getAndMoveToLast(float key)

Description copied from interface: Float2ObjectOrderedMap

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

Specified by:

getAndMoveToLast in interface Float2ObjectOrderedMap<V>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

copy

public Float2ObjectLinkedOpenCustomHashMap<V> copy()

Description copied from interface: Float2ObjectMap

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

Specified by:

copy in interface Float2ObjectOrderedMap<V>

Overrides:

copy in class Float2ObjectOpenCustomHashMap<V>

Returns:

a Shallow Copy of the Map

firstFloatKey

public float firstFloatKey()

Description copied from interface: Float2ObjectOrderedMap

A method to get the first Key of a Map.

Specified by:

firstFloatKey in interface Float2ObjectOrderedMap<V>

Returns:

the first key in the map

pollFirstFloatKey

public float pollFirstFloatKey()

Description copied from interface: Float2ObjectOrderedMap

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

Specified by:

pollFirstFloatKey in interface Float2ObjectOrderedMap<V>

Returns:

the first key in the map

lastFloatKey

public float lastFloatKey()

Description copied from interface: Float2ObjectOrderedMap

A method to get the last Key of a Map.

Specified by:

lastFloatKey in interface Float2ObjectOrderedMap<V>

Returns:

the last key in the map

pollLastFloatKey

public float pollLastFloatKey()

Description copied from interface: Float2ObjectOrderedMap

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

Specified by:

pollLastFloatKey in interface Float2ObjectOrderedMap<V>

Returns:

the last key in the map

firstValue

public V firstValue()

Description copied from interface: Float2ObjectOrderedMap

A method to get the first Value of a Map.

Specified by:

firstValue in interface Float2ObjectOrderedMap<V>

Returns:

the first key in the map

lastValue

public V lastValue()

Description copied from interface: Float2ObjectOrderedMap

A method to get the last Value of a Map.

Specified by:

lastValue in interface Float2ObjectOrderedMap<V>

Returns:

the last key in the map

float2ObjectEntrySet

public ObjectOrderedSet<Float2ObjectMap.Entry<V>> float2ObjectEntrySet()

Description copied from interface: Float2ObjectMap

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

Specified by:

float2ObjectEntrySet in interface Float2ObjectMap<V>

Specified by:

float2ObjectEntrySet in interface Float2ObjectOrderedMap<V>

Overrides:

float2ObjectEntrySet in class Float2ObjectOpenCustomHashMap<V>

Returns:

a EntrySet of the collection

keySet

public FloatOrderedSet keySet()

Specified by:

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

Specified by:

keySet in interface Float2ObjectMap<V>

Specified by:

keySet in interface Float2ObjectOrderedMap<V>

Overrides:

keySet in class Float2ObjectOpenCustomHashMap<V>

values

public ObjectCollection<V> values()

Specified by:

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

Specified by:

values in interface Float2ObjectMap<V>

Overrides:

values in class Float2ObjectOpenCustomHashMap<V>

forEach

public void forEach(FloatObjectConsumer<V> action)

Description copied from interface: Float2ObjectMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Float2ObjectMap<V>

Overrides:

forEach in class Float2ObjectOpenCustomHashMap<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.Float,V>

Overrides:

clear in class Float2ObjectOpenCustomHashMap<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 Float2ObjectOpenCustomHashMap<V>

Parameters:

size - the amount of elements that should be allowed