speiger.src.collections.objects.maps.impl.hash

Class Object2ObjectOpenHashMap<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.hash.Object2ObjectOpenHashMap<T,V>

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.Function<T,V>, java.util.Map<T,V>, Object2ObjectFunction<T,V>, Object2ObjectMap<T,V>

Direct Known Subclasses:

Object2ObjectLinkedOpenHashMap

public class Object2ObjectOpenHashMap<T,V>
extends AbstractObject2ObjectMap<T,V>

A Type Specific Custom implementation of the HashMap Instead of using Wrapper Object Arrays for storing keys and values there is dedicated arrays for storing keys and values. Extra to that there is a couple quality of life functions provided

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

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

Constructor Summary

Constructors

Constructor and Description
Object2ObjectOpenHashMap() Default Constructor
Object2ObjectOpenHashMap(int minCapacity) Constructor that defines the minimum capacity
Object2ObjectOpenHashMap(int minCapacity, float loadFactor) Constructor that defines the minimum capacity and load factor
Object2ObjectOpenHashMap(java.util.Map<? extends T,? extends V> map) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Object2ObjectOpenHashMap(java.util.Map<? extends T,? extends V> map, float loadFactor) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Object2ObjectOpenHashMap(Object2ObjectMap<T,V> map) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Object2ObjectOpenHashMap(Object2ObjectMap<T,V> map, float loadFactor) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Object2ObjectOpenHashMap(T[] keys, V[] values) Helper constructor that allow to create a map from unboxed values
Object2ObjectOpenHashMap(T[] keys, V[] values, float loadFactor) Helper constructor that allow to create a map from unboxed values

Method Summary

Modifier and Type	Method and Description
void	clear()
V	compute(T key, ObjectObjectUnaryOperator<T,V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
V	computeIfAbsent(T key, Object2ObjectFunction<T,V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
V	computeIfPresent(T key, ObjectObjectUnaryOperator<T,V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	containsKey(java.lang.Object key) Deprecated.
boolean	containsValue(java.lang.Object value) Deprecated.
void	forEach(ObjectObjectConsumer<T,V> action) Type Specific forEach method to reduce boxing/unboxing
V	get(java.lang.Object key)
V	getObject(T key) Type Specific get function to reduce boxing/unboxing
V	getOrDefault(java.lang.Object key, V defaultValue)
ObjectSet<T>	keySet()
V	merge(T key, V value, ObjectObjectUnaryOperator<V,V> mappingFunction) A Type Specific merge method to reduce boxing/unboxing
void	mergeAll(Object2ObjectMap<T,V> m, ObjectObjectUnaryOperator<V,V> mappingFunction) A Bulk method for merging Maps.
ObjectSet<Object2ObjectMap.Entry<T,V>>	object2ObjectEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
V	put(T key, V value) Type Specific method to reduce boxing/unboxing of values
V	putIfAbsent(T key, V value) Type Specific method to reduce boxing/unboxing of values
V	rem(T key) Type Specific remove function to reduce boxing/unboxing
V	remOrDefault(T key, V defaultValue) Type-Specific Remove function with a default return value if wanted.
V	remove(java.lang.Object key) Deprecated.
boolean	remove(java.lang.Object key, java.lang.Object value)
V	replace(T key, V value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(T 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.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.Object2ObjectMap

compute, computeIfAbsent, computeIfPresent, forEach, merge, putAll, replaceAll

Methods inherited from interface java.util.Map

isEmpty

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

apply

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Constructor Detail

Object2ObjectOpenHashMap

public Object2ObjectOpenHashMap()

Default Constructor

Object2ObjectOpenHashMap

public Object2ObjectOpenHashMap(int minCapacity)

Constructor that defines the minimum capacity

Parameters:

minCapacity - the minimum capacity the HashMap is allowed to be.

Throws:

java.lang.IllegalStateException - if the minimum capacity is negative

Object2ObjectOpenHashMap

public Object2ObjectOpenHashMap(int minCapacity,
                                float loadFactor)

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

Throws:

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

Object2ObjectOpenHashMap

public Object2ObjectOpenHashMap(T[] keys,
                                V[] values)

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.

Throws:

java.lang.IllegalStateException - if the keys and values do not match in lenght

Object2ObjectOpenHashMap

public Object2ObjectOpenHashMap(T[] keys,
                                V[] values,
                                float loadFactor)

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

Throws:

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

Object2ObjectOpenHashMap

public Object2ObjectOpenHashMap(java.util.Map<? extends T,? extends V> map)

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

Object2ObjectOpenHashMap

public Object2ObjectOpenHashMap(java.util.Map<? extends T,? extends V> map,
                                float loadFactor)

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

Throws:

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

Object2ObjectOpenHashMap

public Object2ObjectOpenHashMap(Object2ObjectMap<T,V> map)

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

Object2ObjectOpenHashMap

public Object2ObjectOpenHashMap(Object2ObjectMap<T,V> map,
                                float loadFactor)

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

Throws:

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

Method Detail

put

public V put(T key,
             V value)

Description copied from interface: Object2ObjectMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

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

Specified by:

put in interface Object2ObjectMap<T,V>

Overrides:

put in class java.util.AbstractMap<T,V>

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

Description copied from interface: Object2ObjectMap

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

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

Deprecated.

Specified by:

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

Overrides:

containsKey in class AbstractObject2ObjectMap<T,V>

containsValue

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

Deprecated.

Specified by:

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

Overrides:

containsValue in class AbstractObject2ObjectMap<T,V>

rem

public V rem(T key)

Description copied from interface: Object2ObjectMap

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

remOrDefault

public V remOrDefault(T key,
                      V defaultValue)

Description copied from interface: Object2ObjectMap

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

Specified by:

remove in interface Object2ObjectMap<T,V>

Overrides:

remove in class java.util.AbstractMap<T,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(java.lang.Object key,
                      java.lang.Object value)

getObject

public V getObject(T key)

Description copied from interface: Object2ObjectFunction

Type Specific get function to reduce boxing/unboxing

Parameters:

key - the value that should be processed

Returns:

the result of the function

get

public V get(java.lang.Object key)

Specified by:

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

Overrides:

get in class AbstractObject2ObjectMap<T,V>

getOrDefault

public V getOrDefault(java.lang.Object key,
                      V defaultValue)

Specified by:

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

Overrides:

getOrDefault in class AbstractObject2ObjectMap<T,V>

object2ObjectEntrySet

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

Description copied from interface: Object2ObjectMap

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

Returns:

a EntrySet of the collection

keySet

public ObjectSet<T> keySet()

Specified by:

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

Specified by:

keySet in interface Object2ObjectMap<T,V>

Overrides:

keySet in class AbstractObject2ObjectMap<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 AbstractObject2ObjectMap<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 AbstractObject2ObjectMap<T,V>

Parameters:

action - processor of the values that are iterator over

replace

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

Description copied from interface: Object2ObjectMap

A Type Specific replace method to replace an existing value

Specified by:

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

Specified by:

replace in interface Object2ObjectMap<T,V>

Overrides:

replace in class AbstractObject2ObjectMap<T,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(T key,
                 V value)

Description copied from interface: Object2ObjectMap

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

Specified by:

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

Specified by:

replace in interface Object2ObjectMap<T,V>

Overrides:

replace in class AbstractObject2ObjectMap<T,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(T key,
                 ObjectObjectUnaryOperator<T,V> mappingFunction)

Description copied from interface: Object2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

compute in interface Object2ObjectMap<T,V>

Overrides:

compute in class AbstractObject2ObjectMap<T,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(T key,
                         Object2ObjectFunction<T,V> mappingFunction)

Description copied from interface: Object2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIfAbsent in interface Object2ObjectMap<T,V>

Overrides:

computeIfAbsent in class AbstractObject2ObjectMap<T,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(T key,
                          ObjectObjectUnaryOperator<T,V> mappingFunction)

Description copied from interface: Object2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIfPresent in interface Object2ObjectMap<T,V>

Overrides:

computeIfPresent in class AbstractObject2ObjectMap<T,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(T key,
               V value,
               ObjectObjectUnaryOperator<V,V> mappingFunction)

Description copied from interface: Object2ObjectMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

merge in interface Object2ObjectMap<T,V>

Overrides:

merge in class AbstractObject2ObjectMap<T,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(Object2ObjectMap<T,V> m,
                     ObjectObjectUnaryOperator<V,V> mappingFunction)

Description copied from interface: Object2ObjectMap

A Bulk method for merging Maps.

Specified by:

mergeAll in interface Object2ObjectMap<T,V>

Overrides:

mergeAll in class AbstractObject2ObjectMap<T,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<T,V>

Overrides:

size in class java.util.AbstractMap<T,V>

clear

public void clear()

Specified by:

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

Overrides:

clear in class java.util.AbstractMap<T,V>