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

Class Short2BooleanOpenCustomHashMap

java.lang.Object

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

speiger.src.collections.shorts.maps.abstracts.AbstractShort2BooleanMap

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

All Implemented Interfaces:

java.util.Map<java.lang.Short,java.lang.Boolean>, Short2BooleanFunction, Short2BooleanMap, ITrimmable

Direct Known Subclasses:

Short2BooleanLinkedOpenCustomHashMap

public class Short2BooleanOpenCustomHashMap
extends AbstractShort2BooleanMap
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.AbstractShort2BooleanMap

AbstractShort2BooleanMap.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.Short2BooleanMap

Short2BooleanMap.BuilderCache, Short2BooleanMap.Entry, Short2BooleanMap.FastEntrySet, Short2BooleanMap.MapBuilder

Constructor Summary

Constructors

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

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
boolean	computeBoolean(short key, ShortBooleanUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	computeBooleanIfAbsent(short key, Short2BooleanFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	computeBooleanIfPresent(short key, ShortBooleanUnaryOperator 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(boolean value) Type Specific method to reduce boxing/unboxing of values
boolean	containsValue(java.lang.Object value) Deprecated.
Short2BooleanOpenCustomHashMap	copy() A Function that does a shallow clone of the Map itself.
void	forEach(ShortBooleanConsumer action) Type Specific forEach method to reduce boxing/unboxing
java.lang.Boolean	get(java.lang.Object key)
boolean	get(short key) A Type Specific get method to reduce boxing/unboxing
boolean	getOrDefault(short key, boolean defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
ShortSet	keySet()
void	mergeAllBoolean(Short2BooleanMap m, BooleanBooleanUnaryOperator mappingFunction) A Bulk method for merging Maps.
boolean	mergeBoolean(short key, boolean value, BooleanBooleanUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
boolean	put(short key, boolean value) Type Specific method to reduce boxing/unboxing of values
boolean	putIfAbsent(short key, boolean value) Type Specific method to reduce boxing/unboxing of values
java.lang.Boolean	remove(java.lang.Object key)
boolean	remove(java.lang.Object key, java.lang.Object value)
boolean	remove(short key) Type Specific remove function to reduce boxing/unboxing
boolean	remove(short key, boolean value) Type Specific remove function to reduce boxing/unboxing
boolean	removeOrDefault(short key, boolean defaultValue) Type-Specific Remove function with a default return value if wanted.
boolean	replace(short key, boolean value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(short key, boolean oldValue, boolean newValue) A Type Specific replace method to replace an existing value
ObjectSet<Short2BooleanMap.Entry>	short2BooleanEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
int	size()
boolean	supplyBooleanIfAbsent(short key, BooleanSupplier 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
BooleanCollection	values()

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

entrySet, equals, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, replaceBooleans, replaceBooleans, 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.Short2BooleanMap

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

Short2BooleanOpenCustomHashMap

public Short2BooleanOpenCustomHashMap(ShortStrategy strategy)

Default Contstructor

Parameters:

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

Short2BooleanOpenCustomHashMap

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

Short2BooleanOpenCustomHashMap

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

Short2BooleanOpenCustomHashMap

public Short2BooleanOpenCustomHashMap(java.lang.Short[] keys,
                                      java.lang.Boolean[] 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

Short2BooleanOpenCustomHashMap

public Short2BooleanOpenCustomHashMap(java.lang.Short[] keys,
                                      java.lang.Boolean[] 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

Short2BooleanOpenCustomHashMap

public Short2BooleanOpenCustomHashMap(short[] keys,
                                      boolean[] 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

Short2BooleanOpenCustomHashMap

public Short2BooleanOpenCustomHashMap(short[] keys,
                                      boolean[] 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

Short2BooleanOpenCustomHashMap

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

Short2BooleanOpenCustomHashMap

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

Short2BooleanOpenCustomHashMap

public Short2BooleanOpenCustomHashMap(Short2BooleanMap 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

Short2BooleanOpenCustomHashMap

public Short2BooleanOpenCustomHashMap(Short2BooleanMap 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 boolean put(short key,
                   boolean value)

Description copied from interface: Short2BooleanMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

put in interface Short2BooleanMap

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

Description copied from interface: Short2BooleanMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

putIfAbsent in interface Short2BooleanMap

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

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsKey in interface Short2BooleanMap

Overrides:

containsKey in class AbstractShort2BooleanMap

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

Specified by:

containsKey in interface Short2BooleanMap

Overrides:

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

Parameters:

key - that is searched for.

Returns:

true if found

See Also:

Map.containsKey(Object)

containsValue

public boolean containsValue(boolean value)

Description copied from interface: Short2BooleanMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsValue in interface Short2BooleanMap

Overrides:

containsValue in class AbstractShort2BooleanMap

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

Specified by:

containsValue in interface Short2BooleanMap

Overrides:

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

Parameters:

value - that is searched for.

Returns:

true if found

See Also:

Map.containsValue(Object)

remove

public boolean remove(short key)

Description copied from interface: Short2BooleanMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Short2BooleanMap

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

removeOrDefault

public boolean removeOrDefault(short key,
                               boolean defaultValue)

Description copied from interface: Short2BooleanMap

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

Specified by:

removeOrDefault in interface Short2BooleanMap

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

Specified by:

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

Specified by:

remove in interface Short2BooleanMap

Overrides:

remove in class AbstractShort2BooleanMap

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

Description copied from interface: Short2BooleanMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Short2BooleanMap

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

Specified by:

remove in interface Short2BooleanMap

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

Description copied from interface: Short2BooleanMap

A Type Specific get method to reduce boxing/unboxing

Specified by:

get in interface Short2BooleanFunction

Specified by:

get in interface Short2BooleanMap

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

get

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

Specified by:

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

Specified by:

get in interface Short2BooleanMap

Overrides:

get in class AbstractShort2BooleanMap

getOrDefault

public boolean getOrDefault(short key,
                            boolean defaultValue)

Description copied from interface: Short2BooleanMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Short2BooleanMap

Overrides:

getOrDefault in class AbstractShort2BooleanMap

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

Description copied from interface: Short2BooleanMap

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 Short2BooleanMap

Overrides:

copy in class AbstractShort2BooleanMap

Returns:

a Shallow Copy of the Map

short2BooleanEntrySet

public ObjectSet<Short2BooleanMap.Entry> short2BooleanEntrySet()

Description copied from interface: Short2BooleanMap

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

Specified by:

short2BooleanEntrySet in interface Short2BooleanMap

Returns:

a EntrySet of the collection

keySet

public ShortSet keySet()

Specified by:

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

Specified by:

keySet in interface Short2BooleanMap

Overrides:

keySet in class AbstractShort2BooleanMap

values

public BooleanCollection values()

Specified by:

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

Specified by:

values in interface Short2BooleanMap

Overrides:

values in class AbstractShort2BooleanMap

forEach

public void forEach(ShortBooleanConsumer action)

Description copied from interface: Short2BooleanMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Short2BooleanMap

Overrides:

forEach in class AbstractShort2BooleanMap

Parameters:

action - processor of the values that are iterator over

replace

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

Description copied from interface: Short2BooleanMap

A Type Specific replace method to replace an existing value

Specified by:

replace in interface Short2BooleanMap

Overrides:

replace in class AbstractShort2BooleanMap

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

Description copied from interface: Short2BooleanMap

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

Specified by:

replace in interface Short2BooleanMap

Overrides:

replace in class AbstractShort2BooleanMap

Parameters:

key - the element that should be searched for

value - the value to replace with.

Returns:

the present value or default return value

computeBoolean

public boolean computeBoolean(short key,
                              ShortBooleanUnaryOperator mappingFunction)

Description copied from interface: Short2BooleanMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeBoolean in interface Short2BooleanMap

Overrides:

computeBoolean in class AbstractShort2BooleanMap

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeBooleanIfAbsent

public boolean computeBooleanIfAbsent(short key,
                                      Short2BooleanFunction mappingFunction)

Description copied from interface: Short2BooleanMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeBooleanIfAbsent in interface Short2BooleanMap

Overrides:

computeBooleanIfAbsent in class AbstractShort2BooleanMap

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

supplyBooleanIfAbsent

public boolean supplyBooleanIfAbsent(short key,
                                     BooleanSupplier valueProvider)

Description copied from interface: Short2BooleanMap

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

Specified by:

supplyBooleanIfAbsent in interface Short2BooleanMap

Overrides:

supplyBooleanIfAbsent in class AbstractShort2BooleanMap

Parameters:

key - the key that should be computed

valueProvider - the value if not present

Returns:

the result of the computed value or present value

computeBooleanIfPresent

public boolean computeBooleanIfPresent(short key,
                                       ShortBooleanUnaryOperator mappingFunction)

Description copied from interface: Short2BooleanMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeBooleanIfPresent in interface Short2BooleanMap

Overrides:

computeBooleanIfPresent in class AbstractShort2BooleanMap

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

mergeBoolean

public boolean mergeBoolean(short key,
                            boolean value,
                            BooleanBooleanUnaryOperator mappingFunction)

Description copied from interface: Short2BooleanMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeBoolean in interface Short2BooleanMap

Overrides:

mergeBoolean in class AbstractShort2BooleanMap

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

mergeAllBoolean

public void mergeAllBoolean(Short2BooleanMap m,
                            BooleanBooleanUnaryOperator mappingFunction)

Description copied from interface: Short2BooleanMap

A Bulk method for merging Maps.

Specified by:

mergeAllBoolean in interface Short2BooleanMap

Overrides:

mergeAllBoolean in class AbstractShort2BooleanMap

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

Overrides:

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

clear

public void clear()

Specified by:

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

Overrides:

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

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