speiger.src.collections.longs.maps.impl.customHash

Class Long2ObjectLinkedOpenCustomHashMap<V>

java.lang.Object

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

speiger.src.collections.longs.maps.abstracts.AbstractLong2ObjectMap<V>

speiger.src.collections.longs.maps.impl.customHash.Long2ObjectOpenCustomHashMap<V>

speiger.src.collections.longs.maps.impl.customHash.Long2ObjectLinkedOpenCustomHashMap<V>

Type Parameters:

V - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.LongFunction<V>, java.util.Map<java.lang.Long,V>, java.util.SortedMap<java.lang.Long,V>, Long2ObjectFunction<V>, Long2ObjectMap<V>, Long2ObjectSortedMap<V>

public class Long2ObjectLinkedOpenCustomHashMap<V>
extends Long2ObjectOpenCustomHashMap<V>
implements Long2ObjectSortedMap<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.longs.maps.abstracts.AbstractLong2ObjectMap

AbstractLong2ObjectMap.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.longs.maps.interfaces.Long2ObjectSortedMap

Long2ObjectSortedMap.FastSortedSet<V>

Nested classes/interfaces inherited from interface speiger.src.collections.longs.maps.interfaces.Long2ObjectMap

Long2ObjectMap.Entry<V>, Long2ObjectMap.FastEntrySet<V>

Constructor Summary

Constructors

Constructor and Description
Long2ObjectLinkedOpenCustomHashMap(int minCapacity, float loadFactor, LongStrategy strategy) Constructor that defines the minimum capacity and load factor
Long2ObjectLinkedOpenCustomHashMap(int minCapacity, LongStrategy strategy) Constructor that defines the minimum capacity
Long2ObjectLinkedOpenCustomHashMap(long[] keys, V[] values, float loadFactor, LongStrategy strategy) Helper constructor that allow to create a map from unboxed values
Long2ObjectLinkedOpenCustomHashMap(java.lang.Long[] keys, V[] values, float loadFactor, LongStrategy strategy) Helper constructor that allow to create a map from boxed values (it will unbox them)
Long2ObjectLinkedOpenCustomHashMap(long[] keys, V[] values, LongStrategy strategy) Helper constructor that allow to create a map from unboxed values
Long2ObjectLinkedOpenCustomHashMap(java.lang.Long[] keys, V[] values, LongStrategy strategy) Helper constructor that allow to create a map from boxed values (it will unbox them)
Long2ObjectLinkedOpenCustomHashMap(Long2ObjectMap<V> map, float loadFactor, LongStrategy strategy) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Long2ObjectLinkedOpenCustomHashMap(Long2ObjectMap<V> map, LongStrategy strategy) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Long2ObjectLinkedOpenCustomHashMap(LongStrategy strategy) Default Constructor
Long2ObjectLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Long,? extends V> map, float loadFactor, LongStrategy strategy) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Long2ObjectLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Long,? extends V> map, LongStrategy 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()
LongComparator	comparator()
long	firstLongKey() A method to get the first Key of a Map.
V	firstValue() A method to get the first Value of a Map.
void	forEach(LongObjectConsumer<V> action) Type Specific forEach method to reduce boxing/unboxing
V	getAndMoveToFirst(long key) A Specific get method that allows to move teh given key/value int the first index.
V	getAndMoveToLast(long key) A Specific get method that allows to move teh given key/value int the last index.
Long2ObjectSortedMap<V>	headMap(long toKey) A Type Specific HeadMap method to reduce boxing/unboxing
LongSet	keySet()
long	lastLongKey() A method to get the last Key of a Map.
V	lastValue() A method to get the last Value of a Map.
ObjectSet<Long2ObjectMap.Entry<V>>	long2ObjectEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
boolean	moveToFirst(long key) A specific move method to move a given key/value to the first index.
boolean	moveToLast(long key) A specific move method to move a given key/value to the last index.
long	pollFirstLongKey() A method to get and remove the first Key of a Map.
long	pollLastLongKey() A method to get and remove the last Key of a Map.
V	putAndMoveToFirst(long key, V value) A customized put method that allows you to insert into the first index.
V	putAndMoveToLast(long key, V value) A customized put method that allows you to insert into the last index.
Long2ObjectSortedMap<V>	subMap(long fromKey, long toKey) A Type Specific SubMap method to reduce boxing/unboxing
Long2ObjectSortedMap<V>	tailMap(long fromKey) A Type Specific TailMap method to reduce boxing/unboxing
ObjectCollection<V>	values()

Methods inherited from class speiger.src.collections.longs.maps.impl.customHash.Long2ObjectOpenCustomHashMap

compute, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, get, getObject, getOrDefault, merge, mergeAll, put, putIfAbsent, remLong, remLongOrDefault, remove, remove, remove, replace, replace, size

Methods inherited from class speiger.src.collections.longs.maps.abstracts.AbstractLong2ObjectMap

entrySet, equals, getDefaultReturnValue, getOrDefault, hashCode, putAll, putAll, putAll, putAllIfAbsent, replaceObjects, replaceObjects, 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 speiger.src.collections.longs.maps.interfaces.Long2ObjectSortedMap

firstKey, headMap, lastKey, subMap, tailMap

Methods inherited from interface java.util.SortedMap

entrySet

Methods inherited from interface speiger.src.collections.longs.maps.interfaces.Long2ObjectMap

compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, entrySet, forEach, get, getDefaultReturnValue, getObject, getOrDefault, getOrDefault, merge, merge, mergeAll, put, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remLong, remLongOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue

Methods inherited from interface java.util.Map

containsValue, equals, hashCode, isEmpty, putAll, size

Methods inherited from interface speiger.src.collections.longs.functions.function.Long2ObjectFunction

apply

Constructor Detail

Long2ObjectLinkedOpenCustomHashMap

public Long2ObjectLinkedOpenCustomHashMap(LongStrategy strategy)

Default Constructor

Parameters:

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

Long2ObjectLinkedOpenCustomHashMap

public Long2ObjectLinkedOpenCustomHashMap(int minCapacity,
                                          LongStrategy 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

Long2ObjectLinkedOpenCustomHashMap

public Long2ObjectLinkedOpenCustomHashMap(int minCapacity,
                                          float loadFactor,
                                          LongStrategy 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

Long2ObjectLinkedOpenCustomHashMap

public Long2ObjectLinkedOpenCustomHashMap(java.lang.Long[] keys,
                                          V[] values,
                                          LongStrategy 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

Long2ObjectLinkedOpenCustomHashMap

public Long2ObjectLinkedOpenCustomHashMap(java.lang.Long[] keys,
                                          V[] values,
                                          float loadFactor,
                                          LongStrategy 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

Long2ObjectLinkedOpenCustomHashMap

public Long2ObjectLinkedOpenCustomHashMap(long[] keys,
                                          V[] values,
                                          LongStrategy 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

Long2ObjectLinkedOpenCustomHashMap

public Long2ObjectLinkedOpenCustomHashMap(long[] keys,
                                          V[] values,
                                          float loadFactor,
                                          LongStrategy 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

Long2ObjectLinkedOpenCustomHashMap

public Long2ObjectLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Long,? extends V> map,
                                          LongStrategy 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

Long2ObjectLinkedOpenCustomHashMap

public Long2ObjectLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Long,? extends V> map,
                                          float loadFactor,
                                          LongStrategy 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

Long2ObjectLinkedOpenCustomHashMap

public Long2ObjectLinkedOpenCustomHashMap(Long2ObjectMap<V> map,
                                          LongStrategy 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

Long2ObjectLinkedOpenCustomHashMap

public Long2ObjectLinkedOpenCustomHashMap(Long2ObjectMap<V> map,
                                          float loadFactor,
                                          LongStrategy 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(long key,
                           V value)

Description copied from interface: Long2ObjectSortedMap

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

Specified by:

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

Description copied from interface: Long2ObjectSortedMap

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 Long2ObjectSortedMap<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(long key)

Description copied from interface: Long2ObjectSortedMap

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

Specified by:

moveToFirst in interface Long2ObjectSortedMap<V>

Parameters:

key - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(long key)

Description copied from interface: Long2ObjectSortedMap

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

Specified by:

moveToLast in interface Long2ObjectSortedMap<V>

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public V getAndMoveToFirst(long key)

Description copied from interface: Long2ObjectSortedMap

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

Specified by:

getAndMoveToFirst in interface Long2ObjectSortedMap<V>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public V getAndMoveToLast(long key)

Description copied from interface: Long2ObjectSortedMap

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

Specified by:

getAndMoveToLast in interface Long2ObjectSortedMap<V>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

comparator

public LongComparator comparator()

Specified by:

comparator in interface java.util.SortedMap<java.lang.Long,V>

Specified by:

comparator in interface Long2ObjectSortedMap<V>

subMap

public Long2ObjectSortedMap<V> subMap(long fromKey,
                                      long toKey)

Description copied from interface: Long2ObjectSortedMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Long2ObjectSortedMap<V>

Parameters:

fromKey - where the submap should start

toKey - where the subMap should end

Returns:

a SubMap that is within the range of the desired range

headMap

public Long2ObjectSortedMap<V> headMap(long toKey)

Description copied from interface: Long2ObjectSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Long2ObjectSortedMap<V>

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

public Long2ObjectSortedMap<V> tailMap(long fromKey)

Description copied from interface: Long2ObjectSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Long2ObjectSortedMap<V>

Parameters:

fromKey - where the TailMap should start

Returns:

a TailMap that is within the range of the desired range

firstLongKey

public long firstLongKey()

Description copied from interface: Long2ObjectSortedMap

A method to get the first Key of a Map.

Specified by:

firstLongKey in interface Long2ObjectSortedMap<V>

Returns:

the first key in the map

pollFirstLongKey

public long pollFirstLongKey()

Description copied from interface: Long2ObjectSortedMap

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

Specified by:

pollFirstLongKey in interface Long2ObjectSortedMap<V>

Returns:

the first key in the map

lastLongKey

public long lastLongKey()

Description copied from interface: Long2ObjectSortedMap

A method to get the last Key of a Map.

Specified by:

lastLongKey in interface Long2ObjectSortedMap<V>

Returns:

the last key in the map

pollLastLongKey

public long pollLastLongKey()

Description copied from interface: Long2ObjectSortedMap

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

Specified by:

pollLastLongKey in interface Long2ObjectSortedMap<V>

Returns:

the last key in the map

firstValue

public V firstValue()

Description copied from interface: Long2ObjectSortedMap

A method to get the first Value of a Map.

Specified by:

firstValue in interface Long2ObjectSortedMap<V>

Returns:

the first key in the map

lastValue

public V lastValue()

Description copied from interface: Long2ObjectSortedMap

A method to get the last Value of a Map.

Specified by:

lastValue in interface Long2ObjectSortedMap<V>

Returns:

the last key in the map

long2ObjectEntrySet

public ObjectSet<Long2ObjectMap.Entry<V>> long2ObjectEntrySet()

Description copied from interface: Long2ObjectMap

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

Specified by:

long2ObjectEntrySet in interface Long2ObjectMap<V>

Overrides:

long2ObjectEntrySet in class Long2ObjectOpenCustomHashMap<V>

Returns:

a EntrySet of the collection

keySet

public LongSet keySet()

Specified by:

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

Specified by:

keySet in interface java.util.SortedMap<java.lang.Long,V>

Specified by:

keySet in interface Long2ObjectMap<V>

Specified by:

keySet in interface Long2ObjectSortedMap<V>

Overrides:

keySet in class Long2ObjectOpenCustomHashMap<V>

values

public ObjectCollection<V> values()

Specified by:

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

Specified by:

values in interface java.util.SortedMap<java.lang.Long,V>

Specified by:

values in interface Long2ObjectMap<V>

Specified by:

values in interface Long2ObjectSortedMap<V>

Overrides:

values in class Long2ObjectOpenCustomHashMap<V>

forEach

public void forEach(LongObjectConsumer<V> action)

Description copied from interface: Long2ObjectMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Long2ObjectMap<V>

Overrides:

forEach in class Long2ObjectOpenCustomHashMap<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.Long,V>

Overrides:

clear in class Long2ObjectOpenCustomHashMap<V>