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

Class Long2ObjectOpenCustomHashMap<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>

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>, Long2ObjectFunction<V>, Long2ObjectMap<V>

Direct Known Subclasses:

Long2ObjectLinkedOpenCustomHashMap

public class Long2ObjectOpenCustomHashMap<V>
extends AbstractLong2ObjectMap<V>

A Type Specific HashMap that allows for custom HashControl. For cases where Objects/primitive do not allow hashcoding this can be really useful and provide a lot of control.

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.Long2ObjectMap

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

Constructor Summary

Constructors

Constructor and Description
Long2ObjectOpenCustomHashMap(int minCapacity, float loadFactor, LongStrategy strategy) Constructor that defines the minimum capacity and load factor
Long2ObjectOpenCustomHashMap(int minCapacity, LongStrategy strategy) Constructor that defines the minimum capacity
Long2ObjectOpenCustomHashMap(long[] keys, V[] values, float loadFactor, LongStrategy strategy) Helper constructor that allow to create a map from unboxed values
Long2ObjectOpenCustomHashMap(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)
Long2ObjectOpenCustomHashMap(long[] keys, V[] values, LongStrategy strategy) Helper constructor that allow to create a map from unboxed values
Long2ObjectOpenCustomHashMap(java.lang.Long[] keys, V[] values, LongStrategy strategy) Helper constructor that allow to create a map from boxed values (it will unbox them)
Long2ObjectOpenCustomHashMap(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.
Long2ObjectOpenCustomHashMap(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.
Long2ObjectOpenCustomHashMap(LongStrategy strategy) Default Contstructor
Long2ObjectOpenCustomHashMap(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.
Long2ObjectOpenCustomHashMap(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()
V	compute(long key, LongObjectUnaryOperator<V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
V	computeIfAbsent(long key, Long2ObjectFunction<V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
V	computeIfPresent(long key, LongObjectUnaryOperator<V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	containsKey(long key) Type Specific method to reduce boxing/unboxing of values
boolean	containsKey(java.lang.Object key) Deprecated.
boolean	containsValue(java.lang.Object value) Deprecated.
void	forEach(LongObjectConsumer<V> action) Type Specific forEach method to reduce boxing/unboxing
V	get(java.lang.Object key)
V	getObject(long key) A Type Specific get method to reduce boxing/unboxing
V	getOrDefault(long key, V defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
LongSet	keySet()
ObjectSet<Long2ObjectMap.Entry<V>>	long2ObjectEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
V	merge(long key, V value, ObjectObjectUnaryOperator<V,V> mappingFunction) A Type Specific merge method to reduce boxing/unboxing
void	mergeAll(Long2ObjectMap<V> m, ObjectObjectUnaryOperator<V,V> mappingFunction) A Bulk method for merging Maps.
V	put(long key, V value) Type Specific method to reduce boxing/unboxing of values
V	putIfAbsent(long key, V value) Type Specific method to reduce boxing/unboxing of values
V	remLong(long key) Type Specific remove function to reduce boxing/unboxing
V	remLongOrDefault(long key, V defaultValue) Type-Specific Remove function with a default return value if wanted.
boolean	remove(long key, V value) Type Specific remove function to reduce boxing/unboxing
V	remove(java.lang.Object key) Deprecated.
boolean	remove(java.lang.Object key, java.lang.Object value)
V	replace(long key, V value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(long key, V oldValue, V newValue) A Type Specific replace method to replace an existing value
int	size()
ObjectCollection<V>	values()

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.Long2ObjectMap

compute, computeIfAbsent, computeIfPresent, forEach, merge, put, putAll, putIfAbsent, replace, replace, replaceAll

Methods inherited from interface java.util.Map

isEmpty

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

apply

Constructor Detail

Long2ObjectOpenCustomHashMap

public Long2ObjectOpenCustomHashMap(LongStrategy strategy)

Default Contstructor

Parameters:

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

Long2ObjectOpenCustomHashMap

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

Long2ObjectOpenCustomHashMap

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

Long2ObjectOpenCustomHashMap

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

Long2ObjectOpenCustomHashMap

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

Long2ObjectOpenCustomHashMap

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

Long2ObjectOpenCustomHashMap

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

Long2ObjectOpenCustomHashMap

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

Long2ObjectOpenCustomHashMap

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

Long2ObjectOpenCustomHashMap

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

Long2ObjectOpenCustomHashMap

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

put

public V put(long key,
             V value)

Description copied from interface: Long2ObjectMap

Type Specific method to reduce boxing/unboxing of values

Parameters:

key - the key that should be inserted,

value - the value that should be inserted

Returns:

the last present value or default return value.

See Also:

Map.put(Object, Object)

putIfAbsent

public V putIfAbsent(long key,
                     V value)

Description copied from interface: Long2ObjectMap

Type Specific method to reduce boxing/unboxing of values

Parameters:

key - the key that should be inserted,

value - the value that should be inserted

Returns:

the last present value or default return value.

See Also:

Map.putIfAbsent(Object, Object)

containsKey

public boolean containsKey(long key)

Description copied from interface: Long2ObjectMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsKey in interface Long2ObjectMap<V>

Overrides:

containsKey in class AbstractLong2ObjectMap<V>

Parameters:

key - element that is searched for

Returns:

if the key is present

containsKey

@Deprecated
public boolean containsKey(java.lang.Object key)

Deprecated.

Specified by:

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

Specified by:

containsKey in interface Long2ObjectMap<V>

Overrides:

containsKey in class java.util.AbstractMap<java.lang.Long,V>

Parameters:

key - that is searched for.

Returns:

true if found

See Also:

Map.containsKey(Object)

containsValue

@Deprecated
public boolean containsValue(java.lang.Object value)

Deprecated.

Specified by:

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

Overrides:

containsValue in class AbstractLong2ObjectMap<V>

remLong

public V remLong(long key)

Description copied from interface: Long2ObjectMap

Type Specific remove function to reduce boxing/unboxing

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

remLongOrDefault

public V remLongOrDefault(long key,
                          V defaultValue)

Description copied from interface: Long2ObjectMap

Type-Specific Remove function with a default return value if wanted.

Parameters:

key - the element that should be removed

defaultValue - the value that should be returned if the entry doesn't exist

Returns:

the value that was removed or default value

See Also:

Map.remove(Object, Object)

remove

@Deprecated
public V remove(java.lang.Object key)

Deprecated.

Specified by:

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

Specified by:

remove in interface Long2ObjectMap<V>

Overrides:

remove in class java.util.AbstractMap<java.lang.Long,V>

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

See Also:

Map.remove(Object)

remove

public boolean remove(long key,
                      V value)

Description copied from interface: Long2ObjectMap

Type Specific remove function to reduce boxing/unboxing

Parameters:

key - the element that should be removed

value - the expected value that should be found

Returns:

true if the key and value was found and removed

See Also:

Map.remove(Object, Object)

remove

public boolean remove(java.lang.Object key,
                      java.lang.Object value)

Parameters:

key - the element that should be removed

value - the expected value that should be found

Returns:

true if the key and value was found and removed

See Also:

Map.remove(Object, Object)

getObject

public V getObject(long key)

Description copied from interface: Long2ObjectMap

A Type Specific get method to reduce boxing/unboxing

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

get

public V get(java.lang.Object key)

Specified by:

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

Specified by:

get in interface Long2ObjectMap<V>

Overrides:

get in class AbstractLong2ObjectMap<V>

getOrDefault

public V getOrDefault(long key,
                      V defaultValue)

Description copied from interface: Long2ObjectMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Long2ObjectMap<V>

Overrides:

getOrDefault in class AbstractLong2ObjectMap<V>

Parameters:

key - the key that is searched for

defaultValue - the value that should be returned if the key is not present

Returns:

the searched value or defaultValue value

long2ObjectEntrySet

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

Description copied from interface: Long2ObjectMap

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

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

Overrides:

keySet in class AbstractLong2ObjectMap<V>

values

public ObjectCollection<V> values()

Specified by:

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

Specified by:

values in interface Long2ObjectMap<V>

Overrides:

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

Parameters:

action - processor of the values that are iterator over

replace

public boolean replace(long key,
                       V oldValue,
                       V newValue)

Description copied from interface: Long2ObjectMap

A Type Specific replace method to replace an existing value

Specified by:

replace in interface Long2ObjectMap<V>

Overrides:

replace in class AbstractLong2ObjectMap<V>

Parameters:

key - the element that should be searched for

oldValue - the expected value to be replaced

newValue - the value to replace the oldValue with.

Returns:

true if the value got replaced

replace

public V replace(long key,
                 V value)

Description copied from interface: Long2ObjectMap

A Type Specific replace method to reduce boxing/unboxing replace an existing value

Specified by:

replace in interface Long2ObjectMap<V>

Overrides:

replace in class AbstractLong2ObjectMap<V>

Parameters:

key - the element that should be searched for

value - the value to replace with.

Returns:

the present value or default return value

compute

public V compute(long key,
                 LongObjectUnaryOperator<V> mappingFunction)

Description copied from interface: Long2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

compute in interface Long2ObjectMap<V>

Overrides:

compute in class AbstractLong2ObjectMap<V>

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeIfAbsent

public V computeIfAbsent(long key,
                         Long2ObjectFunction<V> mappingFunction)

Description copied from interface: Long2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIfAbsent in interface Long2ObjectMap<V>

Overrides:

computeIfAbsent in class AbstractLong2ObjectMap<V>

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value if not present

Returns:

the result of the computed value or present value

computeIfPresent

public V computeIfPresent(long key,
                          LongObjectUnaryOperator<V> mappingFunction)

Description copied from interface: Long2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIfPresent in interface Long2ObjectMap<V>

Overrides:

computeIfPresent in class AbstractLong2ObjectMap<V>

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value if present

Returns:

the result of the default return value or present value

merge

public V merge(long key,
               V value,
               ObjectObjectUnaryOperator<V,V> mappingFunction)

Description copied from interface: Long2ObjectMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

merge in interface Long2ObjectMap<V>

Overrides:

merge in class AbstractLong2ObjectMap<V>

Parameters:

key - the key that should be be searched for

value - the value that should be merged with

mappingFunction - the operator that should generate the new Value

Returns:

the result of the merge

mergeAll

public void mergeAll(Long2ObjectMap<V> m,
                     ObjectObjectUnaryOperator<V,V> mappingFunction)

Description copied from interface: Long2ObjectMap

A Bulk method for merging Maps.

Specified by:

mergeAll in interface Long2ObjectMap<V>

Overrides:

mergeAll in class AbstractLong2ObjectMap<V>

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

size

public int size()

Specified by:

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

Overrides:

size in class java.util.AbstractMap<java.lang.Long,V>

clear

public void clear()

Specified by:

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

Overrides:

clear in class java.util.AbstractMap<java.lang.Long,V>