speiger.src.collections.chars.maps.impl.customHash

Class Char2IntOpenCustomHashMap

java.lang.Object

java.util.AbstractMap<java.lang.Character,java.lang.Integer>

speiger.src.collections.chars.maps.abstracts.AbstractChar2IntMap

speiger.src.collections.chars.maps.impl.customHash.Char2IntOpenCustomHashMap

All Implemented Interfaces:

java.util.Map<java.lang.Character,java.lang.Integer>, Char2IntFunction, Char2IntMap

Direct Known Subclasses:

Char2IntLinkedOpenCustomHashMap

public class Char2IntOpenCustomHashMap
extends AbstractChar2IntMap

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.chars.maps.abstracts.AbstractChar2IntMap

AbstractChar2IntMap.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.chars.maps.interfaces.Char2IntMap

Char2IntMap.Entry, Char2IntMap.FastEntrySet

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	addTo(char key, int value) A Helper method to add a primitives together.
ObjectSet<Char2IntMap.Entry>	char2IntEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
void	clear()
int	computeInt(char key, CharIntUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
int	computeIntIfAbsent(char key, Char2IntFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
int	computeIntIfPresent(char key, CharIntUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	containsKey(char key) Type Specific method to reduce boxing/unboxing of values
boolean	containsKey(java.lang.Object key) Deprecated.
boolean	containsValue(int value) Type Specific method to reduce boxing/unboxing of values
boolean	containsValue(java.lang.Object value) Deprecated.
void	forEach(CharIntConsumer action) Type Specific forEach method to reduce boxing/unboxing
java.lang.Integer	get(java.lang.Object key)
int	getInt(char key) A Type Specific get method to reduce boxing/unboxing
int	getOrDefault(char key, int defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
CharSet	keySet()
void	mergeAllInt(Char2IntMap m, IntIntUnaryOperator mappingFunction) A Bulk method for merging Maps.
int	mergeInt(char key, int value, IntIntUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
int	put(char key, int value) Type Specific method to reduce boxing/unboxing of values
int	putIfAbsent(char key, int value) Type Specific method to reduce boxing/unboxing of values
int	remChar(char key) Type Specific remove function to reduce boxing/unboxing
int	remCharOrDefault(char key, int defaultValue) Type-Specific Remove function with a default return value if wanted.
boolean	remove(char key, int value) Type Specific remove function to reduce boxing/unboxing
java.lang.Integer	remove(java.lang.Object key) Deprecated.
boolean	remove(java.lang.Object key, java.lang.Object value)
int	replace(char key, int value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(char key, int oldValue, int newValue) A Type Specific replace method to replace an existing value
int	size()
IntCollection	values()

Methods inherited from class speiger.src.collections.chars.maps.abstracts.AbstractChar2IntMap

addToAll, entrySet, equals, getDefaultReturnValue, getOrDefault, hashCode, putAll, putAll, putAll, putAllIfAbsent, replaceInts, replaceInts, 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.chars.maps.interfaces.Char2IntMap

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

Methods inherited from interface java.util.Map

isEmpty

Constructor Detail

Char2IntOpenCustomHashMap

public Char2IntOpenCustomHashMap(CharStrategy strategy)

Default Contstructor

Parameters:

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

Char2IntOpenCustomHashMap

public Char2IntOpenCustomHashMap(int minCapacity,
                                 CharStrategy 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

Char2IntOpenCustomHashMap

public Char2IntOpenCustomHashMap(int minCapacity,
                                 float loadFactor,
                                 CharStrategy 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

Char2IntOpenCustomHashMap

public Char2IntOpenCustomHashMap(java.lang.Character[] keys,
                                 java.lang.Integer[] values,
                                 CharStrategy 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

Char2IntOpenCustomHashMap

public Char2IntOpenCustomHashMap(java.lang.Character[] keys,
                                 java.lang.Integer[] values,
                                 float loadFactor,
                                 CharStrategy 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

Char2IntOpenCustomHashMap

public Char2IntOpenCustomHashMap(char[] keys,
                                 int[] values,
                                 CharStrategy 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

Char2IntOpenCustomHashMap

public Char2IntOpenCustomHashMap(char[] keys,
                                 int[] values,
                                 float loadFactor,
                                 CharStrategy 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

Char2IntOpenCustomHashMap

public Char2IntOpenCustomHashMap(java.util.Map<? extends java.lang.Character,? extends java.lang.Integer> map,
                                 CharStrategy 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

Char2IntOpenCustomHashMap

public Char2IntOpenCustomHashMap(java.util.Map<? extends java.lang.Character,? extends java.lang.Integer> map,
                                 float loadFactor,
                                 CharStrategy 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

Char2IntOpenCustomHashMap

public Char2IntOpenCustomHashMap(Char2IntMap map,
                                 CharStrategy 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

Char2IntOpenCustomHashMap

public Char2IntOpenCustomHashMap(Char2IntMap map,
                                 float loadFactor,
                                 CharStrategy 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 int put(char key,
               int value)

Description copied from interface: Char2IntMap

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

Description copied from interface: Char2IntMap

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)

addTo

public int addTo(char key,
                 int value)

Description copied from interface: Char2IntMap

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

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.

containsKey

public boolean containsKey(char key)

Description copied from interface: Char2IntMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsKey in interface Char2IntMap

Overrides:

containsKey in class AbstractChar2IntMap

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

Specified by:

containsKey in interface Char2IntMap

Overrides:

containsKey in class java.util.AbstractMap<java.lang.Character,java.lang.Integer>

Parameters:

key - that is searched for.

Returns:

true if found

See Also:

Map.containsKey(Object)

containsValue

public boolean containsValue(int value)

Description copied from interface: Char2IntMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsValue in interface Char2IntMap

Overrides:

containsValue in class AbstractChar2IntMap

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

Specified by:

containsValue in interface Char2IntMap

Overrides:

containsValue in class java.util.AbstractMap<java.lang.Character,java.lang.Integer>

Parameters:

value - that is searched for.

Returns:

true if found

See Also:

Map.containsValue(Object)

remChar

public int remChar(char key)

Description copied from interface: Char2IntMap

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

remCharOrDefault

public int remCharOrDefault(char key,
                            int defaultValue)

Description copied from interface: Char2IntMap

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

Deprecated.

Specified by:

remove in interface java.util.Map<java.lang.Character,java.lang.Integer>

Specified by:

remove in interface Char2IntMap

Overrides:

remove in class java.util.AbstractMap<java.lang.Character,java.lang.Integer>

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(char key,
                      int value)

Description copied from interface: Char2IntMap

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)

getInt

public int getInt(char key)

Description copied from interface: Char2IntMap

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.Integer get(java.lang.Object key)

Specified by:

get in interface java.util.Map<java.lang.Character,java.lang.Integer>

Specified by:

get in interface Char2IntMap

Overrides:

get in class AbstractChar2IntMap

getOrDefault

public int getOrDefault(char key,
                        int defaultValue)

Description copied from interface: Char2IntMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Char2IntMap

Overrides:

getOrDefault in class AbstractChar2IntMap

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

char2IntEntrySet

public ObjectSet<Char2IntMap.Entry> char2IntEntrySet()

Description copied from interface: Char2IntMap

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

Returns:

a EntrySet of the collection

keySet

public CharSet keySet()

Specified by:

keySet in interface java.util.Map<java.lang.Character,java.lang.Integer>

Specified by:

keySet in interface Char2IntMap

Overrides:

keySet in class AbstractChar2IntMap

values

public IntCollection values()

Specified by:

values in interface java.util.Map<java.lang.Character,java.lang.Integer>

Specified by:

values in interface Char2IntMap

Overrides:

values in class AbstractChar2IntMap

forEach

public void forEach(CharIntConsumer action)

Description copied from interface: Char2IntMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Char2IntMap

Overrides:

forEach in class AbstractChar2IntMap

Parameters:

action - processor of the values that are iterator over

replace

public boolean replace(char key,
                       int oldValue,
                       int newValue)

Description copied from interface: Char2IntMap

A Type Specific replace method to replace an existing value

Specified by:

replace in interface Char2IntMap

Overrides:

replace in class AbstractChar2IntMap

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

Description copied from interface: Char2IntMap

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

Specified by:

replace in interface Char2IntMap

Overrides:

replace in class AbstractChar2IntMap

Parameters:

key - the element that should be searched for

value - the value to replace with.

Returns:

the present value or default return value

computeInt

public int computeInt(char key,
                      CharIntUnaryOperator mappingFunction)

Description copied from interface: Char2IntMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeInt in interface Char2IntMap

Overrides:

computeInt in class AbstractChar2IntMap

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeIntIfAbsent

public int computeIntIfAbsent(char key,
                              Char2IntFunction mappingFunction)

Description copied from interface: Char2IntMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIntIfAbsent in interface Char2IntMap

Overrides:

computeIntIfAbsent in class AbstractChar2IntMap

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

computeIntIfPresent

public int computeIntIfPresent(char key,
                               CharIntUnaryOperator mappingFunction)

Description copied from interface: Char2IntMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIntIfPresent in interface Char2IntMap

Overrides:

computeIntIfPresent in class AbstractChar2IntMap

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

mergeInt

public int mergeInt(char key,
                    int value,
                    IntIntUnaryOperator mappingFunction)

Description copied from interface: Char2IntMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeInt in interface Char2IntMap

Overrides:

mergeInt in class AbstractChar2IntMap

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

mergeAllInt

public void mergeAllInt(Char2IntMap m,
                        IntIntUnaryOperator mappingFunction)

Description copied from interface: Char2IntMap

A Bulk method for merging Maps.

Specified by:

mergeAllInt in interface Char2IntMap

Overrides:

mergeAllInt in class AbstractChar2IntMap

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

Overrides:

size in class java.util.AbstractMap<java.lang.Character,java.lang.Integer>

clear

public void clear()

Specified by:

clear in interface java.util.Map<java.lang.Character,java.lang.Integer>

Overrides:

clear in class java.util.AbstractMap<java.lang.Character,java.lang.Integer>