speiger.src.collections.shorts.maps.impl.hash

Class Short2ObjectOpenHashMap<V>

java.lang.Object

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

speiger.src.collections.shorts.maps.abstracts.AbstractShort2ObjectMap<V>

speiger.src.collections.shorts.maps.impl.hash.Short2ObjectOpenHashMap<V>

Type Parameters:

V - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.Map<java.lang.Short,V>, Short2ObjectFunction<V>, Short2ObjectMap<V>, ITrimmable

Direct Known Subclasses:

Short2ObjectLinkedOpenHashMap

public class Short2ObjectOpenHashMap<V>
extends AbstractShort2ObjectMap<V>
implements ITrimmable

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.shorts.maps.abstracts.AbstractShort2ObjectMap

AbstractShort2ObjectMap.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.shorts.maps.interfaces.Short2ObjectMap

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

Constructor Summary

Constructors

Constructor and Description
Short2ObjectOpenHashMap() Default Constructor
Short2ObjectOpenHashMap(int minCapacity) Constructor that defines the minimum capacity
Short2ObjectOpenHashMap(int minCapacity, float loadFactor) Constructor that defines the minimum capacity and load factor
Short2ObjectOpenHashMap(java.util.Map<? extends java.lang.Short,? extends V> map) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Short2ObjectOpenHashMap(java.util.Map<? extends java.lang.Short,? extends V> map, float loadFactor) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Short2ObjectOpenHashMap(short[] keys, V[] values) Helper constructor that allow to create a map from unboxed values
Short2ObjectOpenHashMap(java.lang.Short[] keys, V[] values) Helper constructor that allow to create a map from boxed values (it will unbox them)
Short2ObjectOpenHashMap(short[] keys, V[] values, float loadFactor) Helper constructor that allow to create a map from unboxed values
Short2ObjectOpenHashMap(java.lang.Short[] keys, V[] values, float loadFactor) Helper constructor that allow to create a map from boxed values (it will unbox them)
Short2ObjectOpenHashMap(Short2ObjectMap<V> map) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Short2ObjectOpenHashMap(Short2ObjectMap<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.

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
V	compute(short key, ShortObjectUnaryOperator<V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
V	computeIfAbsent(short key, Short2ObjectFunction<V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
V	computeIfPresent(short key, ShortObjectUnaryOperator<V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	containsKey(java.lang.Object key) Deprecated.
boolean	containsKey(short key) Type Specific method to reduce boxing/unboxing of values
boolean	containsValue(java.lang.Object value)
Short2ObjectOpenHashMap<V>	copy() A Function that does a shallow clone of the Map itself.
void	forEach(ShortObjectConsumer<V> action) Type Specific forEach method to reduce boxing/unboxing
V	get(java.lang.Object key)
V	get(short key) A Type Specific get method to reduce boxing/unboxing
V	getOrDefault(short key, V defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
ShortSet	keySet()
V	merge(short key, V value, ObjectObjectUnaryOperator<V,V> mappingFunction) A Type Specific merge method to reduce boxing/unboxing
void	mergeAll(Short2ObjectMap<V> m, ObjectObjectUnaryOperator<V,V> mappingFunction) A Bulk method for merging Maps.
V	put(short key, V value) Type Specific method to reduce boxing/unboxing of values
V	putIfAbsent(short key, V value) Type Specific method to reduce boxing/unboxing of values
V	remove(java.lang.Object key)
boolean	remove(java.lang.Object key, java.lang.Object value)
V	remove(short key) Type Specific remove function to reduce boxing/unboxing
boolean	remove(short key, V value) Type Specific remove function to reduce boxing/unboxing
V	removeOrDefault(short key, V defaultValue) Type-Specific Remove function with a default return value if wanted.
V	replace(short key, V value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(short key, V oldValue, V newValue) A Type Specific replace method to replace an existing value
ObjectSet<Short2ObjectMap.Entry<V>>	short2ObjectEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
int	size()
V	supplyIfAbsent(short key, ObjectSupplier<V> valueProvider) A Supplier based computeIfAbsent function to fill the most used usecase of this function
boolean	trim(int size) Trims the original collection down to the size of the current elements or the requested size depending which is bigger
ObjectCollection<V>	values()

Methods inherited from class speiger.src.collections.shorts.maps.abstracts.AbstractShort2ObjectMap

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.utils.ITrimmable

clearAndTrim, trim

Methods inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2ObjectMap

builder, compute, computeIfAbsent, computeIfPresent, forEach, merge, putAll, putAll, putIfAbsent, replace, replace, replaceAll, synchronize, synchronize, unmodifiable

Methods inherited from interface java.util.Map

isEmpty

Constructor Detail

Short2ObjectOpenHashMap

public Short2ObjectOpenHashMap()

Default Constructor

Short2ObjectOpenHashMap

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

Short2ObjectOpenHashMap

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

Short2ObjectOpenHashMap

public Short2ObjectOpenHashMap(java.lang.Short[] keys,
                               V[] values)

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.

Throws:

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

Short2ObjectOpenHashMap

public Short2ObjectOpenHashMap(java.lang.Short[] keys,
                               V[] values,
                               float loadFactor)

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

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

Short2ObjectOpenHashMap

public Short2ObjectOpenHashMap(short[] 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

Short2ObjectOpenHashMap

public Short2ObjectOpenHashMap(short[] 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

Short2ObjectOpenHashMap

public Short2ObjectOpenHashMap(java.util.Map<? extends java.lang.Short,? 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

Short2ObjectOpenHashMap

public Short2ObjectOpenHashMap(java.util.Map<? extends java.lang.Short,? 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

Short2ObjectOpenHashMap

public Short2ObjectOpenHashMap(Short2ObjectMap<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

Short2ObjectOpenHashMap

public Short2ObjectOpenHashMap(Short2ObjectMap<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(short key,
             V value)

Description copied from interface: Short2ObjectMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

put in interface Short2ObjectMap<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(short key,
                     V value)

Description copied from interface: Short2ObjectMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

putIfAbsent in interface Short2ObjectMap<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)

containsKey

public boolean containsKey(short key)

Description copied from interface: Short2ObjectMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsKey in interface Short2ObjectMap<V>

Overrides:

containsKey in class AbstractShort2ObjectMap<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.Short,V>

Specified by:

containsKey in interface Short2ObjectMap<V>

Overrides:

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

Parameters:

key - that is searched for.

Returns:

true if found

See Also:

Map.containsKey(Object)

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

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

Overrides:

containsValue in class AbstractShort2ObjectMap<V>

remove

public V remove(short key)

Description copied from interface: Short2ObjectMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Short2ObjectMap<V>

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

removeOrDefault

public V removeOrDefault(short key,
                         V defaultValue)

Description copied from interface: Short2ObjectMap

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

Specified by:

removeOrDefault in interface Short2ObjectMap<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

public V remove(java.lang.Object key)

Specified by:

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

Specified by:

remove in interface Short2ObjectMap<V>

Overrides:

remove in class AbstractShort2ObjectMap<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(short key,
                      V value)

Description copied from interface: Short2ObjectMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Short2ObjectMap<V>

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)

Specified by:

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

Specified by:

remove in interface Short2ObjectMap<V>

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)

get

public V get(short key)

Description copied from interface: Short2ObjectMap

A Type Specific get method to reduce boxing/unboxing

Specified by:

get in interface Short2ObjectFunction<V>

Specified by:

get in interface Short2ObjectMap<V>

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.Short,V>

Specified by:

get in interface Short2ObjectMap<V>

Overrides:

get in class AbstractShort2ObjectMap<V>

getOrDefault

public V getOrDefault(short key,
                      V defaultValue)

Description copied from interface: Short2ObjectMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Short2ObjectMap<V>

Overrides:

getOrDefault in class AbstractShort2ObjectMap<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

copy

public Short2ObjectOpenHashMap<V> copy()

Description copied from interface: Short2ObjectMap

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

Overrides:

copy in class AbstractShort2ObjectMap<V>

Returns:

a Shallow Copy of the Map

short2ObjectEntrySet

public ObjectSet<Short2ObjectMap.Entry<V>> short2ObjectEntrySet()

Description copied from interface: Short2ObjectMap

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

Specified by:

short2ObjectEntrySet in interface Short2ObjectMap<V>

Returns:

a EntrySet of the collection

keySet

public ShortSet keySet()

Specified by:

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

Specified by:

keySet in interface Short2ObjectMap<V>

Overrides:

keySet in class AbstractShort2ObjectMap<V>

values

public ObjectCollection<V> values()

Specified by:

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

Specified by:

values in interface Short2ObjectMap<V>

Overrides:

values in class AbstractShort2ObjectMap<V>

forEach

public void forEach(ShortObjectConsumer<V> action)

Description copied from interface: Short2ObjectMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Short2ObjectMap<V>

Overrides:

forEach in class AbstractShort2ObjectMap<V>

Parameters:

action - processor of the values that are iterator over

replace

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

Description copied from interface: Short2ObjectMap

A Type Specific replace method to replace an existing value

Specified by:

replace in interface Short2ObjectMap<V>

Overrides:

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

Description copied from interface: Short2ObjectMap

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

Specified by:

replace in interface Short2ObjectMap<V>

Overrides:

replace in class AbstractShort2ObjectMap<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(short key,
                 ShortObjectUnaryOperator<V> mappingFunction)

Description copied from interface: Short2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

compute in interface Short2ObjectMap<V>

Overrides:

compute in class AbstractShort2ObjectMap<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(short key,
                         Short2ObjectFunction<V> mappingFunction)

Description copied from interface: Short2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIfAbsent in interface Short2ObjectMap<V>

Overrides:

computeIfAbsent in class AbstractShort2ObjectMap<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(short key,
                        ObjectSupplier<V> valueProvider)

Description copied from interface: Short2ObjectMap

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

Specified by:

supplyIfAbsent in interface Short2ObjectMap<V>

Overrides:

supplyIfAbsent in class AbstractShort2ObjectMap<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(short key,
                          ShortObjectUnaryOperator<V> mappingFunction)

Description copied from interface: Short2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIfPresent in interface Short2ObjectMap<V>

Overrides:

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

Description copied from interface: Short2ObjectMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

merge in interface Short2ObjectMap<V>

Overrides:

merge in class AbstractShort2ObjectMap<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(Short2ObjectMap<V> m,
                     ObjectObjectUnaryOperator<V,V> mappingFunction)

Description copied from interface: Short2ObjectMap

A Bulk method for merging Maps.

Specified by:

mergeAll in interface Short2ObjectMap<V>

Overrides:

mergeAll in class AbstractShort2ObjectMap<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.Short,V>

Overrides:

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

clear

public void clear()

Specified by:

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

Overrides:

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

trim

public boolean trim(int size)

Description copied from interface: ITrimmable

Trims the original collection down to the size of the current elements or the requested size depending which is bigger

Specified by:

trim in interface ITrimmable

Parameters:

size - the requested trim size.

Returns:

if the internal array has been trimmed.

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

Parameters:

size - the amount of elements that should be allowed