speiger.src.collections.objects.maps.impl.immutable

Class ImmutableObject2ObjectOpenHashMap<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.immutable.ImmutableObject2ObjectOpenHashMap<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>, Object2ObjectOrderedMap<T,V>

public class ImmutableObject2ObjectOpenHashMap<T,V>
extends AbstractObject2ObjectMap<T,V>
implements Object2ObjectOrderedMap<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.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
ImmutableObject2ObjectOpenHashMap(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.
ImmutableObject2ObjectOpenHashMap(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.
ImmutableObject2ObjectOpenHashMap(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.
ImmutableObject2ObjectOpenHashMap(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.
ImmutableObject2ObjectOpenHashMap(T[] keys, V[] values) Helper constructor that allow to create a map from unboxed values
ImmutableObject2ObjectOpenHashMap(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)
boolean	containsValue(java.lang.Object value)
ImmutableObject2ObjectOpenHashMap<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	get(java.lang.Object key)
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.
V	getObject(T key) Type Specific get function to reduce boxing/unboxing
V	getOrDefault(java.lang.Object key, V defaultValue)
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.
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.
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	put(T key, V value) Type Specific method to reduce boxing/unboxing of values
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.
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()
V	supplyIfAbsent(T key, ObjectSupplier<V> valueProvider) A Supplier based computeIfAbsent function to fill the most used usecase of this function
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.Object2ObjectOrderedMap

synchronize, synchronize, unmodifiable

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

builder, compute, computeIfAbsent, computeIfPresent, entrySet, forEach, getDefaultReturnValue, merge, putAll, putAll, putAll, putAllIfAbsent, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue

Methods inherited from interface java.util.Map

equals, hashCode, isEmpty, putAll

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

ImmutableObject2ObjectOpenHashMap

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

ImmutableObject2ObjectOpenHashMap

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

ImmutableObject2ObjectOpenHashMap

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

ImmutableObject2ObjectOpenHashMap

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

ImmutableObject2ObjectOpenHashMap

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

ImmutableObject2ObjectOpenHashMap

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

Specified by:

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

Specified by:

putIfAbsent in interface Object2ObjectMap<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.putIfAbsent(Object, Object)

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

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

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

Overrides:

containsKey in class AbstractObject2ObjectMap<T,V>

containsValue

public boolean containsValue(java.lang.Object value)

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

Specified by:

rem in interface Object2ObjectMap<T,V>

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.

Specified by:

remOrDefault in interface Object2ObjectMap<T,V>

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 AbstractObject2ObjectMap<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)

Specified by:

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

getObject

public V getObject(T key)

Description copied from interface: Object2ObjectFunction

Type Specific get function to reduce boxing/unboxing

Specified by:

getObject in interface Object2ObjectFunction<T,V>

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>

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>

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

copy

public ImmutableObject2ObjectOpenHashMap<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 AbstractObject2ObjectMap<T,V>

Returns:

a Shallow Copy of the Map

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

supplyIfAbsent

public V supplyIfAbsent(T key,
                        ObjectSupplier<V> valueProvider)

Description copied from interface: Object2ObjectMap

A Supplier based computeIfAbsent function to fill the most used usecase of this function

Specified by:

supplyIfAbsent in interface Object2ObjectMap<T,V>

Overrides:

supplyIfAbsent in class AbstractObject2ObjectMap<T,V>

Parameters:

key - the key that should be computed

valueProvider - 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>