speiger.src.collections.chars.utils.maps

Class Char2IntMaps.SynchronizedMap

java.lang.Object

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

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

speiger.src.collections.chars.utils.maps.Char2IntMaps.SynchronizedMap

All Implemented Interfaces:

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

Direct Known Subclasses:

Char2IntMaps.SynchronizedOrderedMap, Char2IntMaps.SynchronizedSortedMap

Enclosing class:

Char2IntMaps

public static class Char2IntMaps.SynchronizedMap
extends AbstractChar2IntMap
implements Char2IntMap

The Synchronized Map implementation used by the synchronizedMap helper function

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

Method Summary

Modifier and Type	Method and Description
int	addTo(char key, int value) A Helper method to add a primitives together.
void	addToAll(Char2IntMap m) A Helper method to bulk add primitives together.
ObjectSet<Char2IntMap.Entry>	char2IntEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
void	clear() Deprecated.
java.lang.Integer	compute(java.lang.Character key, java.util.function.BiFunction<? super java.lang.Character,? super java.lang.Integer,? extends java.lang.Integer> mappingFunction) Deprecated.
java.lang.Integer	computeIfAbsent(java.lang.Character key, java.util.function.Function<? super java.lang.Character,? extends java.lang.Integer> mappingFunction) Deprecated.
java.lang.Integer	computeIfPresent(java.lang.Character key, java.util.function.BiFunction<? super java.lang.Character,? super java.lang.Integer,? extends java.lang.Integer> mappingFunction) Deprecated.
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.
Char2IntMap	copy() A Function that does a shallow clone of the Map itself.
void	forEach(java.util.function.BiConsumer<? super java.lang.Character,? super java.lang.Integer> action) Deprecated.
void	forEach(CharIntConsumer action) Type Specific forEach method to reduce boxing/unboxing
int	get(char key) A Type Specific get method to reduce boxing/unboxing
java.lang.Integer	get(java.lang.Object key) Deprecated.
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) Deprecated.
CharSet	keySet()
java.lang.Integer	merge(java.lang.Character key, java.lang.Integer value, java.util.function.BiFunction<? super java.lang.Integer,? super java.lang.Integer,? extends java.lang.Integer> mappingFunction) Deprecated.
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.
int	put(char key, int value) Type Specific method to reduce boxing/unboxing of values
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.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	putIfAbsent(java.lang.Character key, java.lang.Integer value) Deprecated.
int	putIfAbsent(char key, int value) Type Specific method to reduce boxing/unboxing of values
int	remove(char key) Type Specific remove function to reduce boxing/unboxing
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) Deprecated.
int	removeOrDefault(char key, int defaultValue) Type-Specific Remove function with a default return value if wanted.
java.lang.Integer	replace(java.lang.Character key, java.lang.Integer value) Deprecated.
boolean	replace(java.lang.Character key, java.lang.Integer oldValue, java.lang.Integer newValue) Deprecated.
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	replaceAll(java.util.function.BiFunction<? super java.lang.Character,? super java.lang.Integer,? extends java.lang.Integer> mappingFunction) Deprecated.
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	size()
int	subFrom(char key, int value) A Helper method to subtract from primitive from each other.
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 speiger.src.collections.chars.maps.abstracts.AbstractChar2IntMap

entrySet, equals, hashCode, putAll

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

builder, entrySet, putAll, putAll, putAll, synchronize, synchronize, unmodifiable

Methods inherited from interface java.util.Map

equals, hashCode, isEmpty

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

Overrides:

getDefaultReturnValue in class AbstractChar2IntMap

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

Overrides:

setDefaultReturnValue in class AbstractChar2IntMap

Parameters:

v - value that should be the default return value

Returns:

itself

put

public int put(char key,
               int value)

Description copied from interface: Char2IntMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

put in interface Char2IntMap

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

Specified by:

putIfAbsent in interface Char2IntMap

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)

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

Overrides:

putAllIfAbsent in class AbstractChar2IntMap

Parameters:

m - elements that should be added if not present.

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.

Specified by:

addTo in interface Char2IntMap

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

Description copied from interface: Char2IntMap

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 Char2IntMap.getDefaultReturnValue() If the fence is reached the element will be automaticall removed

Specified by:

subFrom in interface Char2IntMap

Parameters:

key - that should be subtract from

value - that should be subtract

Returns:

the last present or default return value

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

Overrides:

addToAll in class AbstractChar2IntMap

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

Overrides:

putAll in class AbstractChar2IntMap

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 AbstractChar2IntMap

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

Overrides:

putAll in class AbstractChar2IntMap

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)

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

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

get

public int get(char key)

Description copied from interface: Char2IntMap

A Type Specific get method to reduce boxing/unboxing

Specified by:

get in interface Char2IntFunction

Specified by:

get in interface Char2IntMap

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

remove

public int remove(char key)

Description copied from interface: Char2IntMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Char2IntMap

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

removeOrDefault

public int removeOrDefault(char key,
                           int defaultValue)

Description copied from interface: Char2IntMap

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

Specified by:

removeOrDefault in interface Char2IntMap

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

Description copied from interface: Char2IntMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Char2IntMap

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)

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

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

Overrides:

replaceInts in class AbstractChar2IntMap

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

Overrides:

replaceInts in class AbstractChar2IntMap

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

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

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

Overrides:

supplyIntIfAbsent in class AbstractChar2IntMap

Parameters:

key - the key that should be computed

valueProvider - the value if not present

Returns:

the result of the computed 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

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

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

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>

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

Overrides:

copy in class AbstractChar2IntMap

Returns:

a Shallow Copy of the Map

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

char2IntEntrySet

public ObjectSet<Char2IntMap.Entry> char2IntEntrySet()

Description copied from interface: Char2IntMap

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

Specified by:

char2IntEntrySet in interface Char2IntMap

Returns:

a EntrySet of the collection

get

@Deprecated
public java.lang.Integer get(java.lang.Object key)

Deprecated.

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

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

Deprecated.

Specified by:

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

Specified by:

getOrDefault in interface Char2IntMap

Overrides:

getOrDefault in class AbstractChar2IntMap

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)

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)

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 AbstractChar2IntMap

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 AbstractChar2IntMap

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

See Also:

Map.remove(Object)

clear

@Deprecated
public void clear()

Deprecated.

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>

putIfAbsent

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

Deprecated.

Specified by:

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

Specified by:

putIfAbsent in interface Char2IntMap

remove

@Deprecated
public boolean remove(java.lang.Object key,
                                   java.lang.Object value)

Deprecated.

Specified by:

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

Specified by:

remove in interface Char2IntMap

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)

replace

@Deprecated
public boolean replace(java.lang.Character key,
                                    java.lang.Integer oldValue,
                                    java.lang.Integer newValue)

Deprecated.

Specified by:

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

Specified by:

replace in interface Char2IntMap

replace

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

Deprecated.

Specified by:

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

Specified by:

replace in interface Char2IntMap

replaceAll

@Deprecated
public void replaceAll(java.util.function.BiFunction<? super java.lang.Character,? super java.lang.Integer,? extends java.lang.Integer> mappingFunction)

Deprecated.

Specified by:

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

Specified by:

replaceAll in interface Char2IntMap

compute

@Deprecated
public java.lang.Integer compute(java.lang.Character key,
                                              java.util.function.BiFunction<? super java.lang.Character,? super java.lang.Integer,? extends java.lang.Integer> mappingFunction)

Deprecated.

Specified by:

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

Specified by:

compute in interface Char2IntMap

computeIfAbsent

@Deprecated
public java.lang.Integer computeIfAbsent(java.lang.Character key,
                                                      java.util.function.Function<? super java.lang.Character,? extends java.lang.Integer> mappingFunction)

Deprecated.

Specified by:

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

Specified by:

computeIfAbsent in interface Char2IntMap

computeIfPresent

@Deprecated
public java.lang.Integer computeIfPresent(java.lang.Character key,
                                                       java.util.function.BiFunction<? super java.lang.Character,? super java.lang.Integer,? extends java.lang.Integer> mappingFunction)

Deprecated.

Specified by:

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

Specified by:

computeIfPresent in interface Char2IntMap

merge

@Deprecated
public java.lang.Integer merge(java.lang.Character key,
                                            java.lang.Integer value,
                                            java.util.function.BiFunction<? super java.lang.Integer,? super java.lang.Integer,? extends java.lang.Integer> mappingFunction)

Deprecated.

Specified by:

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

Specified by:

merge in interface Char2IntMap

forEach

@Deprecated
public void forEach(java.util.function.BiConsumer<? super java.lang.Character,? super java.lang.Integer> action)

Deprecated.

Specified by:

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

Specified by:

forEach in interface Char2IntMap