speiger.src.collections.chars.utils.maps

Class Char2CharMaps.SynchronizedMap

java.lang.Object

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

speiger.src.collections.chars.maps.abstracts.AbstractChar2CharMap

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

All Implemented Interfaces:

java.util.Map<java.lang.Character,java.lang.Character>, Char2CharFunction, Char2CharMap

Direct Known Subclasses:

Char2CharMaps.SynchronizedOrderedMap, Char2CharMaps.SynchronizedSortedMap

Enclosing class:

Char2CharMaps

public static class Char2CharMaps.SynchronizedMap
extends AbstractChar2CharMap
implements Char2CharMap

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

AbstractChar2CharMap.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.Char2CharMap

Char2CharMap.BuilderCache, Char2CharMap.Entry, Char2CharMap.FastEntrySet, Char2CharMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
char	addTo(char key, char value) A Helper method to add a primitives together.
void	addToAll(Char2CharMap m) A Helper method to bulk add primitives together.
ObjectSet<Char2CharMap.Entry>	char2CharEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
void	clear() Deprecated.
java.lang.Character	compute(java.lang.Character key, java.util.function.BiFunction<? super java.lang.Character,? super java.lang.Character,? extends java.lang.Character> mappingFunction) Deprecated.
char	computeChar(char key, CharCharUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
char	computeCharIfAbsent(char key, Char2CharFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
char	computeCharIfPresent(char key, CharCharUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
java.lang.Character	computeIfAbsent(java.lang.Character key, java.util.function.Function<? super java.lang.Character,? extends java.lang.Character> mappingFunction) Deprecated.
java.lang.Character	computeIfPresent(java.lang.Character key, java.util.function.BiFunction<? super java.lang.Character,? super java.lang.Character,? extends java.lang.Character> mappingFunction) Deprecated.
boolean	containsKey(char key) Type Specific method to reduce boxing/unboxing of values
boolean	containsKey(java.lang.Object key) Deprecated.
boolean	containsValue(char value) Type Specific method to reduce boxing/unboxing of values
boolean	containsValue(java.lang.Object value) Deprecated.
Char2CharMap	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.Character> action) Deprecated.
void	forEach(CharCharConsumer action) Type Specific forEach method to reduce boxing/unboxing
char	get(char key) A Type Specific get method to reduce boxing/unboxing
java.lang.Character	get(java.lang.Object key) Deprecated.
char	getDefaultReturnValue() Method to see what the default return value is.
char	getOrDefault(char key, char defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
java.lang.Character	getOrDefault(java.lang.Object key, java.lang.Character defaultValue) Deprecated.
CharSet	keySet()
java.lang.Character	merge(java.lang.Character key, java.lang.Character value, java.util.function.BiFunction<? super java.lang.Character,? super java.lang.Character,? extends java.lang.Character> mappingFunction) Deprecated.
void	mergeAllChar(Char2CharMap m, CharCharUnaryOperator mappingFunction) A Bulk method for merging Maps.
char	mergeChar(char key, char value, CharCharUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
java.lang.Character	put(java.lang.Character key, java.lang.Character value) Deprecated.
char	put(char key, char value) Type Specific method to reduce boxing/unboxing of values
void	putAll(char[] keys, char[] 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(Char2CharMap m) Type Specific function for the bull putting of values
void	putAll(java.util.Map<? extends java.lang.Character,? extends java.lang.Character> m)
void	putAllIfAbsent(Char2CharMap m) Type-Specific bulk put method put elements into the map if not present.
java.lang.Character	putIfAbsent(java.lang.Character key, java.lang.Character value) Deprecated.
char	putIfAbsent(char key, char value) Type Specific method to reduce boxing/unboxing of values
char	remove(char key) Type Specific remove function to reduce boxing/unboxing
boolean	remove(char key, char value) Type Specific remove function to reduce boxing/unboxing
java.lang.Character	remove(java.lang.Object key) Deprecated.
boolean	remove(java.lang.Object key, java.lang.Object value) Deprecated.
char	removeOrDefault(char key, char defaultValue) Type-Specific Remove function with a default return value if wanted.
java.lang.Character	replace(java.lang.Character key, java.lang.Character value) Deprecated.
boolean	replace(java.lang.Character key, java.lang.Character oldValue, java.lang.Character newValue) Deprecated.
char	replace(char key, char value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(char key, char oldValue, char newValue) A Type Specific replace method to replace an existing value
void	replaceAll(java.util.function.BiFunction<? super java.lang.Character,? super java.lang.Character,? extends java.lang.Character> mappingFunction) Deprecated.
void	replaceChars(Char2CharMap m) Type-Specific bulk replace method.
void	replaceChars(CharCharUnaryOperator mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
AbstractChar2CharMap	setDefaultReturnValue(char v) Method to define the default return value if a requested key isn't present
int	size()
char	subFrom(char key, char value) A Helper method to subtract from primitive from each other.
char	supplyCharIfAbsent(char key, CharSupplier valueProvider) A Supplier based computeIfAbsent function to fill the most used usecase of this function
CharCollection	values()

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

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

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

Methods inherited from interface java.util.Map

equals, hashCode, isEmpty

Method Detail

getDefaultReturnValue

public char getDefaultReturnValue()

Description copied from interface: Char2CharMap

Method to see what the default return value is.

Specified by:

getDefaultReturnValue in interface Char2CharMap

Overrides:

getDefaultReturnValue in class AbstractChar2CharMap

Returns:

default return value

setDefaultReturnValue

public AbstractChar2CharMap setDefaultReturnValue(char v)

Description copied from interface: Char2CharMap

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

Specified by:

setDefaultReturnValue in interface Char2CharMap

Overrides:

setDefaultReturnValue in class AbstractChar2CharMap

Parameters:

v - value that should be the default return value

Returns:

itself

put

public char put(char key,
                char value)

Description copied from interface: Char2CharMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

put in interface Char2CharMap

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

Description copied from interface: Char2CharMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

putIfAbsent in interface Char2CharMap

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(Char2CharMap m)

Description copied from interface: Char2CharMap

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

Specified by:

putAllIfAbsent in interface Char2CharMap

Overrides:

putAllIfAbsent in class AbstractChar2CharMap

Parameters:

m - elements that should be added if not present.

addTo

public char addTo(char key,
                  char value)

Description copied from interface: Char2CharMap

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

Specified by:

addTo in interface Char2CharMap

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

Description copied from interface: Char2CharMap

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

Specified by:

subFrom in interface Char2CharMap

Parameters:

key - that should be subtract from

value - that should be subtract

Returns:

the last present or default return value

addToAll

public void addToAll(Char2CharMap m)

Description copied from interface: Char2CharMap

A Helper method to bulk add primitives together.

Specified by:

addToAll in interface Char2CharMap

Overrides:

addToAll in class AbstractChar2CharMap

Parameters:

m - the values that should be added/inserted

putAll

public void putAll(Char2CharMap m)

Description copied from interface: Char2CharMap

Type Specific function for the bull putting of values

Specified by:

putAll in interface Char2CharMap

Overrides:

putAll in class AbstractChar2CharMap

Parameters:

m - the elements that should be inserted

putAll

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

Specified by:

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

Overrides:

putAll in class AbstractChar2CharMap

putAll

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

Description copied from interface: Char2CharMap

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

Specified by:

putAll in interface Char2CharMap

Overrides:

putAll in class AbstractChar2CharMap

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

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsKey in interface Char2CharMap

Overrides:

containsKey in class AbstractChar2CharMap

Parameters:

key - element that is searched for

Returns:

if the key is present

containsValue

public boolean containsValue(char value)

Description copied from interface: Char2CharMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsValue in interface Char2CharMap

Overrides:

containsValue in class AbstractChar2CharMap

Parameters:

value - element that is searched for

Returns:

if the value is present

get

public char get(char key)

Description copied from interface: Char2CharMap

A Type Specific get method to reduce boxing/unboxing

Specified by:

get in interface Char2CharFunction

Specified by:

get in interface Char2CharMap

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

remove

public char remove(char key)

Description copied from interface: Char2CharMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Char2CharMap

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

removeOrDefault

public char removeOrDefault(char key,
                            char defaultValue)

Description copied from interface: Char2CharMap

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

Specified by:

removeOrDefault in interface Char2CharMap

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

Description copied from interface: Char2CharMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Char2CharMap

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,
                       char oldValue,
                       char newValue)

Description copied from interface: Char2CharMap

A Type Specific replace method to replace an existing value

Specified by:

replace in interface Char2CharMap

Overrides:

replace in class AbstractChar2CharMap

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

Description copied from interface: Char2CharMap

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

Specified by:

replace in interface Char2CharMap

Overrides:

replace in class AbstractChar2CharMap

Parameters:

key - the element that should be searched for

value - the value to replace with.

Returns:

the present value or default return value

replaceChars

public void replaceChars(Char2CharMap m)

Description copied from interface: Char2CharMap

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

Specified by:

replaceChars in interface Char2CharMap

Overrides:

replaceChars in class AbstractChar2CharMap

Parameters:

m - elements that should be replaced.

replaceChars

public void replaceChars(CharCharUnaryOperator mappingFunction)

Description copied from interface: Char2CharMap

A Type Specific mass replace method to reduce boxing/unboxing

Specified by:

replaceChars in interface Char2CharMap

Overrides:

replaceChars in class AbstractChar2CharMap

Parameters:

mappingFunction - operation to replace all values

computeChar

public char computeChar(char key,
                        CharCharUnaryOperator mappingFunction)

Description copied from interface: Char2CharMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeChar in interface Char2CharMap

Overrides:

computeChar in class AbstractChar2CharMap

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeCharIfAbsent

public char computeCharIfAbsent(char key,
                                Char2CharFunction mappingFunction)

Description copied from interface: Char2CharMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeCharIfAbsent in interface Char2CharMap

Overrides:

computeCharIfAbsent in class AbstractChar2CharMap

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

computeCharIfPresent

public char computeCharIfPresent(char key,
                                 CharCharUnaryOperator mappingFunction)

Description copied from interface: Char2CharMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeCharIfPresent in interface Char2CharMap

Overrides:

computeCharIfPresent in class AbstractChar2CharMap

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

supplyCharIfAbsent

public char supplyCharIfAbsent(char key,
                               CharSupplier valueProvider)

Description copied from interface: Char2CharMap

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

Specified by:

supplyCharIfAbsent in interface Char2CharMap

Overrides:

supplyCharIfAbsent in class AbstractChar2CharMap

Parameters:

key - the key that should be computed

valueProvider - the value if not present

Returns:

the result of the computed value or present value

mergeChar

public char mergeChar(char key,
                      char value,
                      CharCharUnaryOperator mappingFunction)

Description copied from interface: Char2CharMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeChar in interface Char2CharMap

Overrides:

mergeChar in class AbstractChar2CharMap

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

mergeAllChar

public void mergeAllChar(Char2CharMap m,
                         CharCharUnaryOperator mappingFunction)

Description copied from interface: Char2CharMap

A Bulk method for merging Maps.

Specified by:

mergeAllChar in interface Char2CharMap

Overrides:

mergeAllChar in class AbstractChar2CharMap

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

getOrDefault

public char getOrDefault(char key,
                         char defaultValue)

Description copied from interface: Char2CharMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Char2CharMap

Overrides:

getOrDefault in class AbstractChar2CharMap

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(CharCharConsumer action)

Description copied from interface: Char2CharMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Char2CharMap

Overrides:

forEach in class AbstractChar2CharMap

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

Overrides:

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

copy

public Char2CharMap copy()

Description copied from interface: Char2CharMap

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 Char2CharMap

Overrides:

copy in class AbstractChar2CharMap

Returns:

a Shallow Copy of the Map

keySet

public CharSet keySet()

Specified by:

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

Specified by:

keySet in interface Char2CharMap

Overrides:

keySet in class AbstractChar2CharMap

values

public CharCollection values()

Specified by:

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

Specified by:

values in interface Char2CharMap

Overrides:

values in class AbstractChar2CharMap

char2CharEntrySet

public ObjectSet<Char2CharMap.Entry> char2CharEntrySet()

Description copied from interface: Char2CharMap

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

Specified by:

char2CharEntrySet in interface Char2CharMap

Returns:

a EntrySet of the collection

get

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

Deprecated.

Specified by:

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

Specified by:

get in interface Char2CharMap

Overrides:

get in class AbstractChar2CharMap

getOrDefault

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

Deprecated.

Specified by:

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

Specified by:

getOrDefault in interface Char2CharMap

Overrides:

getOrDefault in class AbstractChar2CharMap

containsValue

@Deprecated
public boolean containsValue(java.lang.Object value)

Deprecated.

Specified by:

containsValue in interface java.util.Map<java.lang.Character,java.lang.Character>

Specified by:

containsValue in interface Char2CharMap

Overrides:

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

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

Specified by:

containsKey in interface Char2CharMap

Overrides:

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

Parameters:

key - that is searched for.

Returns:

true if found

See Also:

Map.containsKey(Object)

put

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

Deprecated.

Specified by:

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

Specified by:

put in interface Char2CharMap

Overrides:

put in class AbstractChar2CharMap

remove

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

Deprecated.

Specified by:

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

Specified by:

remove in interface Char2CharMap

Overrides:

remove in class AbstractChar2CharMap

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

Overrides:

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

putIfAbsent

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

Deprecated.

Specified by:

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

Specified by:

putIfAbsent in interface Char2CharMap

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

Specified by:

remove in interface Char2CharMap

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.Character oldValue,
                                    java.lang.Character newValue)

Deprecated.

Specified by:

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

Specified by:

replace in interface Char2CharMap

replace

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

Deprecated.

Specified by:

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

Specified by:

replace in interface Char2CharMap

replaceAll

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

Deprecated.

Specified by:

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

Specified by:

replaceAll in interface Char2CharMap

compute

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

Deprecated.

Specified by:

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

Specified by:

compute in interface Char2CharMap

computeIfAbsent

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

Deprecated.

Specified by:

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

Specified by:

computeIfAbsent in interface Char2CharMap

computeIfPresent

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

Deprecated.

Specified by:

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

Specified by:

computeIfPresent in interface Char2CharMap

merge

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

Deprecated.

Specified by:

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

Specified by:

merge in interface Char2CharMap

forEach

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

Deprecated.

Specified by:

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

Specified by:

forEach in interface Char2CharMap