speiger.src.collections.chars.maps.abstracts

Class AbstractChar2IntMap

java.lang.Object

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

Char2IntArrayMap, Char2IntAVLTreeMap, Char2IntConcurrentOpenHashMap, Char2IntMaps.EmptyMap, Char2IntMaps.SingletonMap, Char2IntMaps.SynchronizedMap, Char2IntMaps.UnmodifyableMap, Char2IntOpenCustomHashMap, Char2IntOpenHashMap, Char2IntRBTreeMap, ImmutableChar2IntOpenHashMap

public abstract class AbstractChar2IntMap
extends java.util.AbstractMap<java.lang.Character,java.lang.Integer>
implements Char2IntMap

A Base Implementation of a Type Specific Map to reduce boxing/unboxing

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractChar2IntMap.BasicEntry A Simple Type Specific Entry class to reduce boxing/unboxing

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.BuilderCache, Char2IntMap.Entry, Char2IntMap.FastEntrySet, Char2IntMap.MapBuilder

Constructor Summary

Constructors

Constructor and Description
AbstractChar2IntMap()

Method Summary

Modifier and Type	Method and Description
void	addToAll(Char2IntMap m) A Helper method to bulk add primitives together.
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	containsValue(int value) Type Specific method to reduce boxing/unboxing of values
Char2IntMap	copy() A Function that does a shallow clone of the Map itself.
ObjectSet<java.util.Map.Entry<java.lang.Character,java.lang.Integer>>	entrySet()
boolean	equals(java.lang.Object o)
void	forEach(CharIntConsumer action) Type Specific forEach method to reduce boxing/unboxing
java.lang.Integer	get(java.lang.Object key)
int	getDefaultReturnValue() Method to see what the default return value is.
int	getOrDefault(char key, int defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
java.lang.Integer	getOrDefault(java.lang.Object key, java.lang.Integer defaultValue)
int	hashCode()
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
java.lang.Integer	put(java.lang.Character key, java.lang.Integer value) Deprecated.
void	putAll(char[] keys, int[] values, int offset, int size) Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
void	putAll(Char2IntMap m) Type Specific function for the bull putting of values
void	putAll(java.lang.Character[] keys, java.lang.Integer[] values, int offset, int size) Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances
void	putAll(java.util.Map<? extends java.lang.Character,? extends java.lang.Integer> m)
void	putAllIfAbsent(Char2IntMap m) Type-Specific bulk put method put elements into the map if not present.
java.lang.Integer	remove(java.lang.Object key)
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
void	replaceInts(Char2IntMap m) Type-Specific bulk replace method.
void	replaceInts(CharIntUnaryOperator mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
AbstractChar2IntMap	setDefaultReturnValue(int v) Method to define the default return value if a requested key isn't present
int	supplyIntIfAbsent(char key, IntSupplier valueProvider) A Supplier based computeIfAbsent function to fill the most used usecase of this function
IntCollection	values()

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, size, 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

addTo, builder, char2IntEntrySet, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, forEach, get, merge, put, putAll, putAll, putIfAbsent, putIfAbsent, remove, remove, remove, removeOrDefault, replace, replace, replaceAll, subFrom, synchronize, synchronize, unmodifiable

Methods inherited from interface java.util.Map

clear, isEmpty, size

Constructor Detail

AbstractChar2IntMap

public AbstractChar2IntMap()

Method Detail

getDefaultReturnValue

public int getDefaultReturnValue()

Description copied from interface: Char2IntMap

Method to see what the default return value is.

Specified by:

getDefaultReturnValue in interface Char2IntMap

Returns:

default return value

setDefaultReturnValue

public AbstractChar2IntMap setDefaultReturnValue(int v)

Description copied from interface: Char2IntMap

Method to define the default return value if a requested key isn't present

Specified by:

setDefaultReturnValue in interface Char2IntMap

Parameters:

v - value that should be the default return value

Returns:

itself

copy

public Char2IntMap copy()

Description copied from interface: Char2IntMap

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 Char2IntMap

Returns:

a Shallow Copy of the Map

put

@Deprecated
public java.lang.Integer put(java.lang.Character key,
                                          java.lang.Integer value)

Deprecated.

Specified by:

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

Specified by:

put in interface Char2IntMap

Overrides:

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

addToAll

public void addToAll(Char2IntMap m)

Description copied from interface: Char2IntMap

A Helper method to bulk add primitives together.

Specified by:

addToAll in interface Char2IntMap

Parameters:

m - the values that should be added/inserted

putAll

public void putAll(Char2IntMap m)

Description copied from interface: Char2IntMap

Type Specific function for the bull putting of values

Specified by:

putAll in interface Char2IntMap

Parameters:

m - the elements that should be inserted

putAll

public void putAll(java.util.Map<? extends java.lang.Character,? extends java.lang.Integer> m)

Specified by:

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

Overrides:

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

putAll

public void putAll(char[] keys,
                   int[] values,
                   int offset,
                   int size)

Description copied from interface: Char2IntMap

Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances

Specified by:

putAll in interface Char2IntMap

Parameters:

keys - the keys that should be added

values - the values that should be added

offset - where the to start in the array

size - how many elements should be added

See Also:

Map.putAll(Map)

putAll

public void putAll(java.lang.Character[] keys,
                   java.lang.Integer[] values,
                   int offset,
                   int size)

Description copied from interface: Char2IntMap

Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances

Specified by:

putAll in interface Char2IntMap

Parameters:

keys - the keys that should be added

values - the values that should be added

offset - where the to start in the array

size - how many elements should be added

See Also:

Map.putAll(Map)

putAllIfAbsent

public void putAllIfAbsent(Char2IntMap m)

Description copied from interface: Char2IntMap

Type-Specific bulk put method put elements into the map if not present.

Specified by:

putAllIfAbsent in interface Char2IntMap

Parameters:

m - elements that should be added if not present.

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

Parameters:

key - element that is searched for

Returns:

if the key is present

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

Parameters:

value - element that is searched for

Returns:

if the value is present

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

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

Parameters:

key - the element that should be searched for

value - the value to replace with.

Returns:

the present value or default return value

replaceInts

public void replaceInts(Char2IntMap m)

Description copied from interface: Char2IntMap

Type-Specific bulk replace method. Could be seen as putAllIfPresent

Specified by:

replaceInts in interface Char2IntMap

Parameters:

m - elements that should be replaced.

replaceInts

public void replaceInts(CharIntUnaryOperator mappingFunction)

Description copied from interface: Char2IntMap

A Type Specific mass replace method to reduce boxing/unboxing

Specified by:

replaceInts in interface Char2IntMap

Parameters:

mappingFunction - operation to replace all values

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

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

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

supplyIntIfAbsent

public int supplyIntIfAbsent(char key,
                             IntSupplier valueProvider)

Description copied from interface: Char2IntMap

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

Specified by:

supplyIntIfAbsent in interface Char2IntMap

Parameters:

key - the key that should be computed

valueProvider - 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

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

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

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new 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 java.util.AbstractMap<java.lang.Character,java.lang.Integer>

getOrDefault

public java.lang.Integer getOrDefault(java.lang.Object key,
                                      java.lang.Integer defaultValue)

Specified by:

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

Specified by:

getOrDefault in interface Char2IntMap

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

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

remove

public java.lang.Integer remove(java.lang.Object key)

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)

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

Parameters:

action - processor of the values that are iterator over

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

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

entrySet

public ObjectSet<java.util.Map.Entry<java.lang.Character,java.lang.Integer>> entrySet()

Specified by:

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

Specified by:

entrySet in interface Char2IntMap

Specified by:

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

equals

public boolean equals(java.lang.Object o)

Specified by:

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

Overrides:

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

hashCode

public int hashCode()

Specified by:

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

Overrides:

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