speiger.src.collections.objects.maps.impl.customHash

Class Object2BooleanOpenCustomHashMap<T>

java.lang.Object

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

speiger.src.collections.objects.maps.abstracts.AbstractObject2BooleanMap<T>

speiger.src.collections.objects.maps.impl.customHash.Object2BooleanOpenCustomHashMap<T>

Type Parameters:

T - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.Predicate<T>, java.util.Map<T,java.lang.Boolean>, Object2BooleanFunction<T>, Object2BooleanMap<T>

Direct Known Subclasses:

Object2BooleanLinkedOpenCustomHashMap

public class Object2BooleanOpenCustomHashMap<T>
extends AbstractObject2BooleanMap<T>

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.objects.maps.abstracts.AbstractObject2BooleanMap

AbstractObject2BooleanMap.BasicEntry<T>

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

Object2BooleanMap.Entry<T>, Object2BooleanMap.FastEntrySet<T>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	computeBoolean(T key, ObjectBooleanUnaryOperator<T> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	computeBooleanIfAbsent(T key, Object2BooleanFunction<T> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	computeBooleanIfPresent(T key, ObjectBooleanUnaryOperator<T> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	containsKey(java.lang.Object key) Deprecated.
boolean	containsValue(boolean value) Type Specific method to reduce boxing/unboxing of values
boolean	containsValue(java.lang.Object value) Deprecated.
void	forEach(ObjectBooleanConsumer<T> action) Type Specific forEach method to reduce boxing/unboxing
java.lang.Boolean	get(java.lang.Object key)
boolean	getBoolean(T key) A Type Specific get method to reduce boxing/unboxing
boolean	getOrDefault(T key, boolean defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
ObjectSet<T>	keySet()
void	mergeAllBoolean(Object2BooleanMap<T> m, BooleanBooleanUnaryOperator mappingFunction) A Bulk method for merging Maps.
boolean	mergeBoolean(T key, boolean value, BooleanBooleanUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
ObjectSet<Object2BooleanMap.Entry<T>>	object2BooleanEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
boolean	put(T key, boolean value) Type Specific method to reduce boxing/unboxing of values
boolean	putIfAbsent(T key, boolean value) Type Specific method to reduce boxing/unboxing of values
boolean	rem(T key) Type Specific remove function to reduce boxing/unboxing
boolean	remOrDefault(T key, boolean defaultValue) Type-Specific Remove function with a default return value if wanted.
java.lang.Boolean	remove(java.lang.Object key) Deprecated.
boolean	remove(java.lang.Object key, java.lang.Object value)
boolean	remove(T key, boolean value) Type Specific remove function to reduce boxing/unboxing
boolean	replace(T key, boolean value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(T key, boolean oldValue, boolean newValue) A Type Specific replace method to replace an existing value
int	size()
BooleanCollection	values()

Methods inherited from class speiger.src.collections.objects.maps.abstracts.AbstractObject2BooleanMap

entrySet, equals, getDefaultReturnValue, getOrDefault, hashCode, putAll, putAll, putAll, putAllIfAbsent, replaceBooleans, replaceBooleans, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap

isEmpty, put, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

compute, computeIfAbsent, computeIfPresent, forEach, merge, put, putAll, putIfAbsent, replace, replace, replaceAll

Methods inherited from interface java.util.Map

isEmpty

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

and, andType, negate, or, orType, test

Methods inherited from interface java.util.function.Predicate

isEqual

Constructor Detail

Object2BooleanOpenCustomHashMap

public Object2BooleanOpenCustomHashMap(ObjectStrategy<? super T> strategy)

Default Contstructor

Parameters:

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

Object2BooleanOpenCustomHashMap

public Object2BooleanOpenCustomHashMap(int minCapacity,
                                       ObjectStrategy<? super T> 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

Object2BooleanOpenCustomHashMap

public Object2BooleanOpenCustomHashMap(int minCapacity,
                                       float loadFactor,
                                       ObjectStrategy<? super T> 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

Object2BooleanOpenCustomHashMap

public Object2BooleanOpenCustomHashMap(T[] keys,
                                       java.lang.Boolean[] values,
                                       ObjectStrategy<? super T> 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

Object2BooleanOpenCustomHashMap

public Object2BooleanOpenCustomHashMap(T[] keys,
                                       java.lang.Boolean[] values,
                                       float loadFactor,
                                       ObjectStrategy<? super T> 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

Object2BooleanOpenCustomHashMap

public Object2BooleanOpenCustomHashMap(T[] keys,
                                       boolean[] values,
                                       ObjectStrategy<? super T> 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

Object2BooleanOpenCustomHashMap

public Object2BooleanOpenCustomHashMap(T[] keys,
                                       boolean[] values,
                                       float loadFactor,
                                       ObjectStrategy<? super T> 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

Object2BooleanOpenCustomHashMap

public Object2BooleanOpenCustomHashMap(java.util.Map<? extends T,? extends java.lang.Boolean> map,
                                       ObjectStrategy<? super T> 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

Object2BooleanOpenCustomHashMap

public Object2BooleanOpenCustomHashMap(java.util.Map<? extends T,? extends java.lang.Boolean> map,
                                       float loadFactor,
                                       ObjectStrategy<? super T> 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

Object2BooleanOpenCustomHashMap

public Object2BooleanOpenCustomHashMap(Object2BooleanMap<T> map,
                                       ObjectStrategy<? super T> 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

Object2BooleanOpenCustomHashMap

public Object2BooleanOpenCustomHashMap(Object2BooleanMap<T> map,
                                       float loadFactor,
                                       ObjectStrategy<? super T> 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(T key,
                   boolean value)

Description copied from interface: Object2BooleanMap

Type Specific method to reduce boxing/unboxing of values

Parameters:

key - the key that should be inserted,

value - the value that should be inserted

Returns:

the last present value or default return value.

See Also:

Map.put(Object, Object)

putIfAbsent

public boolean putIfAbsent(T key,
                           boolean value)

Description copied from interface: Object2BooleanMap

Type Specific method to reduce boxing/unboxing of values

Parameters:

key - the key that should be inserted,

value - the value that should be inserted

Returns:

the last present value or default return value.

See Also:

Map.putIfAbsent(Object, Object)

containsKey

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

Deprecated.

Specified by:

containsKey in interface java.util.Map<T,java.lang.Boolean>

Overrides:

containsKey in class AbstractObject2BooleanMap<T>

containsValue

public boolean containsValue(boolean value)

Description copied from interface: Object2BooleanMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsValue in interface Object2BooleanMap<T>

Overrides:

containsValue in class AbstractObject2BooleanMap<T>

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

Specified by:

containsValue in interface Object2BooleanMap<T>

Overrides:

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

Parameters:

value - that is searched for.

Returns:

true if found

See Also:

Map.containsValue(Object)

rem

public boolean rem(T key)

Description copied from interface: Object2BooleanMap

Type Specific remove function to reduce boxing/unboxing

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

remOrDefault

public boolean remOrDefault(T key,
                            boolean defaultValue)

Description copied from interface: Object2BooleanMap

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

Parameters:

key - the element that should be removed

defaultValue - the value that should be returned if the entry doesn't exist

Returns:

the value that was removed or default value

See Also:

Map.remove(Object, Object)

remove

@Deprecated
public java.lang.Boolean remove(java.lang.Object key)

Deprecated.

Specified by:

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

Specified by:

remove in interface Object2BooleanMap<T>

Overrides:

remove in class java.util.AbstractMap<T,java.lang.Boolean>

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

Description copied from interface: Object2BooleanMap

Type Specific remove function to reduce boxing/unboxing

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)

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)

getBoolean

public boolean getBoolean(T key)

Description copied from interface: Object2BooleanMap

A Type Specific get method to reduce boxing/unboxing

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

Specified by:

get in interface Object2BooleanMap<T>

Overrides:

get in class AbstractObject2BooleanMap<T>

getOrDefault

public boolean getOrDefault(T key,
                            boolean defaultValue)

Description copied from interface: Object2BooleanMap

A Type Specific getOrDefault method to reduce boxing/unboxing

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

object2BooleanEntrySet

public ObjectSet<Object2BooleanMap.Entry<T>> object2BooleanEntrySet()

Description copied from interface: Object2BooleanMap

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

Returns:

a EntrySet of the collection

keySet

public ObjectSet<T> keySet()

Specified by:

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

Specified by:

keySet in interface Object2BooleanMap<T>

Overrides:

keySet in class AbstractObject2BooleanMap<T>

values

public BooleanCollection values()

Specified by:

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

Specified by:

values in interface Object2BooleanMap<T>

Overrides:

values in class AbstractObject2BooleanMap<T>

forEach

public void forEach(ObjectBooleanConsumer<T> action)

Description copied from interface: Object2BooleanMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Object2BooleanMap<T>

Overrides:

forEach in class AbstractObject2BooleanMap<T>

Parameters:

action - processor of the values that are iterator over

replace

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

Description copied from interface: Object2BooleanMap

A Type Specific replace method to replace an existing value

Specified by:

replace in interface Object2BooleanMap<T>

Overrides:

replace in class AbstractObject2BooleanMap<T>

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

Description copied from interface: Object2BooleanMap

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

Specified by:

replace in interface Object2BooleanMap<T>

Overrides:

replace in class AbstractObject2BooleanMap<T>

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(T key,
                              ObjectBooleanUnaryOperator<T> mappingFunction)

Description copied from interface: Object2BooleanMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeBoolean in interface Object2BooleanMap<T>

Overrides:

computeBoolean in class AbstractObject2BooleanMap<T>

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(T key,
                                      Object2BooleanFunction<T> mappingFunction)

Description copied from interface: Object2BooleanMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeBooleanIfAbsent in interface Object2BooleanMap<T>

Overrides:

computeBooleanIfAbsent in class AbstractObject2BooleanMap<T>

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

computeBooleanIfPresent

public boolean computeBooleanIfPresent(T key,
                                       ObjectBooleanUnaryOperator<T> mappingFunction)

Description copied from interface: Object2BooleanMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeBooleanIfPresent in interface Object2BooleanMap<T>

Overrides:

computeBooleanIfPresent in class AbstractObject2BooleanMap<T>

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(T key,
                            boolean value,
                            BooleanBooleanUnaryOperator mappingFunction)

Description copied from interface: Object2BooleanMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeBoolean in interface Object2BooleanMap<T>

Overrides:

mergeBoolean in class AbstractObject2BooleanMap<T>

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(Object2BooleanMap<T> m,
                            BooleanBooleanUnaryOperator mappingFunction)

Description copied from interface: Object2BooleanMap

A Bulk method for merging Maps.

Specified by:

mergeAllBoolean in interface Object2BooleanMap<T>

Overrides:

mergeAllBoolean in class AbstractObject2BooleanMap<T>

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

Overrides:

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

clear

public void clear()

Specified by:

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

Overrides:

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