speiger.src.collections.shorts.maps.impl.customHash

Class Short2ShortOpenCustomHashMap

java.lang.Object

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

speiger.src.collections.shorts.maps.abstracts.AbstractShort2ShortMap

speiger.src.collections.shorts.maps.impl.customHash.Short2ShortOpenCustomHashMap

All Implemented Interfaces:

java.util.Map<java.lang.Short,java.lang.Short>, Short2ShortFunction, Short2ShortMap, ITrimmable

Direct Known Subclasses:

Short2ShortLinkedOpenCustomHashMap

public class Short2ShortOpenCustomHashMap
extends AbstractShort2ShortMap
implements ITrimmable

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

AbstractShort2ShortMap.BasicEntry

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

Short2ShortMap.BuilderCache, Short2ShortMap.Entry, Short2ShortMap.FastEntrySet, Short2ShortMap.MapBuilder

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
short	addTo(short key, short value) A Helper method to add a primitives together.
void	clear()
void	clearAndTrim(int size) Trims the collection down to the requested size and clears all elements while doing so
short	computeShort(short key, ShortShortUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
short	computeShortIfAbsent(short key, Short2ShortFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
short	computeShortIfPresent(short key, ShortShortUnaryOperator 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) Deprecated.
boolean	containsValue(short value) Type Specific method to reduce boxing/unboxing of values
Short2ShortOpenCustomHashMap	copy() A Function that does a shallow clone of the Map itself.
void	forEach(ShortShortConsumer action) Type Specific forEach method to reduce boxing/unboxing
java.lang.Short	get(java.lang.Object key)
short	get(short key) A Type Specific get method to reduce boxing/unboxing
short	getOrDefault(short key, short defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
ShortSet	keySet()
void	mergeAllShort(Short2ShortMap m, ShortShortUnaryOperator mappingFunction) A Bulk method for merging Maps.
short	mergeShort(short key, short value, ShortShortUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
short	put(short key, short value) Type Specific method to reduce boxing/unboxing of values
short	putIfAbsent(short key, short value) Type Specific method to reduce boxing/unboxing of values
java.lang.Short	remove(java.lang.Object key)
boolean	remove(java.lang.Object key, java.lang.Object value)
short	remove(short key) Type Specific remove function to reduce boxing/unboxing
boolean	remove(short key, short value) Type Specific remove function to reduce boxing/unboxing
short	removeOrDefault(short key, short defaultValue) Type-Specific Remove function with a default return value if wanted.
short	replace(short key, short value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(short key, short oldValue, short newValue) A Type Specific replace method to replace an existing value
ObjectSet<Short2ShortMap.Entry>	short2ShortEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
int	size()
short	subFrom(short key, short value) A Helper method to subtract from primitive from each other.
short	supplyShortIfAbsent(short key, ShortSupplier 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
ShortCollection	values()

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

addToAll, entrySet, equals, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, replaceShorts, replaceShorts, 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.Short2ShortMap

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

Short2ShortOpenCustomHashMap

public Short2ShortOpenCustomHashMap(ShortStrategy strategy)

Default Contstructor

Parameters:

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

Short2ShortOpenCustomHashMap

public Short2ShortOpenCustomHashMap(int minCapacity,
                                    ShortStrategy 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

Short2ShortOpenCustomHashMap

public Short2ShortOpenCustomHashMap(int minCapacity,
                                    float loadFactor,
                                    ShortStrategy 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

Short2ShortOpenCustomHashMap

public Short2ShortOpenCustomHashMap(java.lang.Short[] keys,
                                    java.lang.Short[] values,
                                    ShortStrategy 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

Short2ShortOpenCustomHashMap

public Short2ShortOpenCustomHashMap(java.lang.Short[] keys,
                                    java.lang.Short[] values,
                                    float loadFactor,
                                    ShortStrategy 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

Short2ShortOpenCustomHashMap

public Short2ShortOpenCustomHashMap(short[] keys,
                                    short[] values,
                                    ShortStrategy 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

Short2ShortOpenCustomHashMap

public Short2ShortOpenCustomHashMap(short[] keys,
                                    short[] values,
                                    float loadFactor,
                                    ShortStrategy 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

Short2ShortOpenCustomHashMap

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

Short2ShortOpenCustomHashMap

public Short2ShortOpenCustomHashMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Short> map,
                                    float loadFactor,
                                    ShortStrategy 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

Short2ShortOpenCustomHashMap

public Short2ShortOpenCustomHashMap(Short2ShortMap map,
                                    ShortStrategy 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

Short2ShortOpenCustomHashMap

public Short2ShortOpenCustomHashMap(Short2ShortMap map,
                                    float loadFactor,
                                    ShortStrategy 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 short put(short key,
                 short value)

Description copied from interface: Short2ShortMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

put in interface Short2ShortMap

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 short putIfAbsent(short key,
                         short value)

Description copied from interface: Short2ShortMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

putIfAbsent in interface Short2ShortMap

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)

addTo

public short addTo(short key,
                   short value)

Description copied from interface: Short2ShortMap

A Helper method to add a primitives together. If key is not present then this functions as a put.

Specified by:

addTo in interface Short2ShortMap

Parameters:

key - the key that should be inserted,

value - the value that should be inserted / added

Returns:

the last present value or default return value.

subFrom

public short subFrom(short key,
                     short value)

Description copied from interface: Short2ShortMap

A Helper method to subtract from primitive from each other. If the key is not present it will just return the defaultValue How the implementation works is that it will subtract from the current value (if not present it will do nothing) and fence it to the Short2ShortMap.getDefaultReturnValue() If the fence is reached the element will be automaticall removed

Specified by:

subFrom in interface Short2ShortMap

Parameters:

key - that should be subtract from

value - that should be subtract

Returns:

the last present or default return value

containsKey

public boolean containsKey(short key)

Description copied from interface: Short2ShortMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsKey in interface Short2ShortMap

Overrides:

containsKey in class AbstractShort2ShortMap

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,java.lang.Short>

Specified by:

containsKey in interface Short2ShortMap

Overrides:

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

Parameters:

key - that is searched for.

Returns:

true if found

See Also:

Map.containsKey(Object)

containsValue

public boolean containsValue(short value)

Description copied from interface: Short2ShortMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsValue in interface Short2ShortMap

Overrides:

containsValue in class AbstractShort2ShortMap

Parameters:

value - element that is searched for

Returns:

if the value is present

containsValue

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

Deprecated.

Specified by:

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

Specified by:

containsValue in interface Short2ShortMap

Overrides:

containsValue in class java.util.AbstractMap<java.lang.Short,java.lang.Short>

Parameters:

value - that is searched for.

Returns:

true if found

See Also:

Map.containsValue(Object)

remove

public short remove(short key)

Description copied from interface: Short2ShortMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Short2ShortMap

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

removeOrDefault

public short removeOrDefault(short key,
                             short defaultValue)

Description copied from interface: Short2ShortMap

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

Specified by:

removeOrDefault in interface Short2ShortMap

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 java.lang.Short remove(java.lang.Object key)

Specified by:

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

Specified by:

remove in interface Short2ShortMap

Overrides:

remove in class AbstractShort2ShortMap

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,
                      short value)

Description copied from interface: Short2ShortMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Short2ShortMap

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,java.lang.Short>

Specified by:

remove in interface Short2ShortMap

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 short get(short key)

Description copied from interface: Short2ShortMap

A Type Specific get method to reduce boxing/unboxing

Specified by:

get in interface Short2ShortFunction

Specified by:

get in interface Short2ShortMap

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

get

public java.lang.Short get(java.lang.Object key)

Specified by:

get in interface java.util.Map<java.lang.Short,java.lang.Short>

Specified by:

get in interface Short2ShortMap

Overrides:

get in class AbstractShort2ShortMap

getOrDefault

public short getOrDefault(short key,
                          short defaultValue)

Description copied from interface: Short2ShortMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Short2ShortMap

Overrides:

getOrDefault in class AbstractShort2ShortMap

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 Short2ShortOpenCustomHashMap copy()

Description copied from interface: Short2ShortMap

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 Short2ShortMap

Overrides:

copy in class AbstractShort2ShortMap

Returns:

a Shallow Copy of the Map

short2ShortEntrySet

public ObjectSet<Short2ShortMap.Entry> short2ShortEntrySet()

Description copied from interface: Short2ShortMap

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

Specified by:

short2ShortEntrySet in interface Short2ShortMap

Returns:

a EntrySet of the collection

keySet

public ShortSet keySet()

Specified by:

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

Specified by:

keySet in interface Short2ShortMap

Overrides:

keySet in class AbstractShort2ShortMap

values

public ShortCollection values()

Specified by:

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

Specified by:

values in interface Short2ShortMap

Overrides:

values in class AbstractShort2ShortMap

forEach

public void forEach(ShortShortConsumer action)

Description copied from interface: Short2ShortMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Short2ShortMap

Overrides:

forEach in class AbstractShort2ShortMap

Parameters:

action - processor of the values that are iterator over

replace

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

Description copied from interface: Short2ShortMap

A Type Specific replace method to replace an existing value

Specified by:

replace in interface Short2ShortMap

Overrides:

replace in class AbstractShort2ShortMap

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 short replace(short key,
                     short value)

Description copied from interface: Short2ShortMap

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

Specified by:

replace in interface Short2ShortMap

Overrides:

replace in class AbstractShort2ShortMap

Parameters:

key - the element that should be searched for

value - the value to replace with.

Returns:

the present value or default return value

computeShort

public short computeShort(short key,
                          ShortShortUnaryOperator mappingFunction)

Description copied from interface: Short2ShortMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeShort in interface Short2ShortMap

Overrides:

computeShort in class AbstractShort2ShortMap

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeShortIfAbsent

public short computeShortIfAbsent(short key,
                                  Short2ShortFunction mappingFunction)

Description copied from interface: Short2ShortMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeShortIfAbsent in interface Short2ShortMap

Overrides:

computeShortIfAbsent in class AbstractShort2ShortMap

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

supplyShortIfAbsent

public short supplyShortIfAbsent(short key,
                                 ShortSupplier valueProvider)

Description copied from interface: Short2ShortMap

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

Specified by:

supplyShortIfAbsent in interface Short2ShortMap

Overrides:

supplyShortIfAbsent in class AbstractShort2ShortMap

Parameters:

key - the key that should be computed

valueProvider - the value if not present

Returns:

the result of the computed value or present value

computeShortIfPresent

public short computeShortIfPresent(short key,
                                   ShortShortUnaryOperator mappingFunction)

Description copied from interface: Short2ShortMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeShortIfPresent in interface Short2ShortMap

Overrides:

computeShortIfPresent in class AbstractShort2ShortMap

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

mergeShort

public short mergeShort(short key,
                        short value,
                        ShortShortUnaryOperator mappingFunction)

Description copied from interface: Short2ShortMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeShort in interface Short2ShortMap

Overrides:

mergeShort in class AbstractShort2ShortMap

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

mergeAllShort

public void mergeAllShort(Short2ShortMap m,
                          ShortShortUnaryOperator mappingFunction)

Description copied from interface: Short2ShortMap

A Bulk method for merging Maps.

Specified by:

mergeAllShort in interface Short2ShortMap

Overrides:

mergeAllShort in class AbstractShort2ShortMap

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,java.lang.Short>

Overrides:

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

clear

public void clear()

Specified by:

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

Overrides:

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

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