speiger.src.collections.objects.maps.abstracts

Class AbstractObject2CharMap<T>

java.lang.Object

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

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

Type Parameters:

T - the keyType of elements maintained by this Collection

All Implemented Interfaces:

java.util.Map<T,java.lang.Character>, ToCharFunction<T>, Object2CharMap<T>

Direct Known Subclasses:

Enum2CharMap, ImmutableObject2CharOpenHashMap, Object2CharArrayMap, Object2CharAVLTreeMap, Object2CharConcurrentOpenHashMap, Object2CharMaps.EmptyMap, Object2CharMaps.SingletonMap, Object2CharMaps.SynchronizedMap, Object2CharMaps.UnmodifyableMap, Object2CharOpenCustomHashMap, Object2CharOpenHashMap, Object2CharRBTreeMap

public abstract class AbstractObject2CharMap<T>
extends java.util.AbstractMap<T,java.lang.Character>
implements Object2CharMap<T>

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	AbstractObject2CharMap.BasicEntry<T> 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.objects.maps.interfaces.Object2CharMap

Object2CharMap.BuilderCache<T>, Object2CharMap.Entry<T>, Object2CharMap.FastEntrySet<T>, Object2CharMap.MapBuilder

Constructor Summary

Constructors

Constructor and Description
AbstractObject2CharMap()

Method Summary

Modifier and Type	Method and Description
void	addToAll(Object2CharMap<T> m) A Helper method to bulk add primitives together.
char	computeChar(T key, ObjectCharUnaryOperator<T> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
char	computeCharIfAbsent(T key, ToCharFunction<T> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
char	computeCharIfPresent(T key, ObjectCharUnaryOperator<T> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	containsKey(java.lang.Object key)
boolean	containsValue(char value) Type Specific method to reduce boxing/unboxing of values
Object2CharMap<T>	copy() A Function that does a shallow clone of the Map itself.
ObjectSet<java.util.Map.Entry<T,java.lang.Character>>	entrySet()
boolean	equals(java.lang.Object o)
void	forEach(ObjectCharConsumer<T> action) Type Specific forEach method to reduce boxing/unboxing
java.lang.Character	get(java.lang.Object key)
char	getDefaultReturnValue() Method to see what the default return value is.
java.lang.Character	getOrDefault(java.lang.Object key, java.lang.Character defaultValue)
int	hashCode()
ObjectSet<T>	keySet()
void	mergeAllChar(Object2CharMap<T> m, CharCharUnaryOperator mappingFunction) A Bulk method for merging Maps.
char	mergeChar(T key, char value, CharCharUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
java.lang.Character	put(T key, java.lang.Character value) Deprecated.
void	putAll(java.util.Map<? extends T,? extends java.lang.Character> m)
void	putAll(Object2CharMap<T> m) Type Specific function for the bull putting of values
void	putAll(T[] 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(T[] keys, java.lang.Character[] 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	putAllIfAbsent(Object2CharMap<T> m) Type-Specific bulk put method put elements into the map if not present.
java.lang.Character	remove(java.lang.Object key)
char	replace(T key, char value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(T key, char oldValue, char newValue) A Type Specific replace method to replace an existing value
void	replaceChars(Object2CharMap<T> m) Type-Specific bulk replace method.
void	replaceChars(ObjectCharUnaryOperator<T> mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
AbstractObject2CharMap<T>	setDefaultReturnValue(char v) Method to define the default return value if a requested key isn't present
char	supplyCharIfAbsent(T key, CharSupplier valueProvider) A Supplier based computeIfAbsent function to fill the most used usecase of this function
CharCollection	values()

Methods inherited from class java.util.AbstractMap

clear, containsValue, isEmpty, size, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

addTo, applyAsChar, builder, compute, computeIfAbsent, computeIfPresent, containsValue, forEach, getChar, getOrDefault, merge, object2CharEntrySet, put, put, put, putAll, putAll, putIfAbsent, putIfAbsent, rem, remOrDefault, remove, remove, replace, replace, replaceAll, subFrom, synchronize, synchronize, unmodifiable

Methods inherited from interface java.util.Map

clear, isEmpty, size

Constructor Detail

AbstractObject2CharMap

public AbstractObject2CharMap()

Method Detail

getDefaultReturnValue

public char getDefaultReturnValue()

Description copied from interface: Object2CharMap

Method to see what the default return value is.

Specified by:

getDefaultReturnValue in interface Object2CharMap<T>

Returns:

default return value

setDefaultReturnValue

public AbstractObject2CharMap<T> setDefaultReturnValue(char v)

Description copied from interface: Object2CharMap

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

Specified by:

setDefaultReturnValue in interface Object2CharMap<T>

Parameters:

v - value that should be the default return value

Returns:

itself

copy

public Object2CharMap<T> copy()

Description copied from interface: Object2CharMap

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 Object2CharMap<T>

Returns:

a Shallow Copy of the Map

put

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

Deprecated.

Specified by:

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

Specified by:

put in interface Object2CharMap<T>

Overrides:

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

addToAll

public void addToAll(Object2CharMap<T> m)

Description copied from interface: Object2CharMap

A Helper method to bulk add primitives together.

Specified by:

addToAll in interface Object2CharMap<T>

Parameters:

m - the values that should be added/inserted

putAll

public void putAll(Object2CharMap<T> m)

Description copied from interface: Object2CharMap

Type Specific function for the bull putting of values

Specified by:

putAll in interface Object2CharMap<T>

Parameters:

m - the elements that should be inserted

putAll

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

Specified by:

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

Overrides:

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

putAll

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

Description copied from interface: Object2CharMap

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

Specified by:

putAll in interface Object2CharMap<T>

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(T[] keys,
                   java.lang.Character[] values,
                   int offset,
                   int size)

Description copied from interface: Object2CharMap

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

Specified by:

putAll in interface Object2CharMap<T>

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(Object2CharMap<T> m)

Description copied from interface: Object2CharMap

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

Specified by:

putAllIfAbsent in interface Object2CharMap<T>

Parameters:

m - elements that should be added if not present.

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

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

Overrides:

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

containsValue

public boolean containsValue(char value)

Description copied from interface: Object2CharMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsValue in interface Object2CharMap<T>

Parameters:

value - element that is searched for

Returns:

if the value is present

replace

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

Description copied from interface: Object2CharMap

A Type Specific replace method to replace an existing value

Specified by:

replace in interface Object2CharMap<T>

Parameters:

key - the element that should be searched for

oldValue - the expected value to be replaced

newValue - the value to replace the oldValue with.

Returns:

true if the value got replaced

replace

public char replace(T key,
                    char value)

Description copied from interface: Object2CharMap

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

Specified by:

replace in interface Object2CharMap<T>

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(Object2CharMap<T> m)

Description copied from interface: Object2CharMap

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

Specified by:

replaceChars in interface Object2CharMap<T>

Parameters:

m - elements that should be replaced.

replaceChars

public void replaceChars(ObjectCharUnaryOperator<T> mappingFunction)

Description copied from interface: Object2CharMap

A Type Specific mass replace method to reduce boxing/unboxing

Specified by:

replaceChars in interface Object2CharMap<T>

Parameters:

mappingFunction - operation to replace all values

computeChar

public char computeChar(T key,
                        ObjectCharUnaryOperator<T> mappingFunction)

Description copied from interface: Object2CharMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeChar in interface Object2CharMap<T>

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

Description copied from interface: Object2CharMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeCharIfAbsent in interface Object2CharMap<T>

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value if not present

Returns:

the result of the computed value or present value

supplyCharIfAbsent

public char supplyCharIfAbsent(T key,
                               CharSupplier valueProvider)

Description copied from interface: Object2CharMap

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

Specified by:

supplyCharIfAbsent in interface Object2CharMap<T>

Parameters:

key - the key that should be computed

valueProvider - the value if not present

Returns:

the result of the computed value or present value

computeCharIfPresent

public char computeCharIfPresent(T key,
                                 ObjectCharUnaryOperator<T> mappingFunction)

Description copied from interface: Object2CharMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeCharIfPresent in interface Object2CharMap<T>

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value if present

Returns:

the result of the default return value or present value

mergeChar

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

Description copied from interface: Object2CharMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeChar in interface Object2CharMap<T>

Parameters:

key - the key that should be be searched for

value - the value that should be merged with

mappingFunction - the operator that should generate the new Value

Returns:

the result of the merge

mergeAllChar

public void mergeAllChar(Object2CharMap<T> m,
                         CharCharUnaryOperator mappingFunction)

Description copied from interface: Object2CharMap

A Bulk method for merging Maps.

Specified by:

mergeAllChar in interface Object2CharMap<T>

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

get

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

Specified by:

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

Specified by:

get in interface Object2CharMap<T>

Overrides:

get in class java.util.AbstractMap<T,java.lang.Character>

getOrDefault

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

Specified by:

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

Specified by:

getOrDefault in interface Object2CharMap<T>

remove

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

Specified by:

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

Specified by:

remove in interface Object2CharMap<T>

Overrides:

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

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(ObjectCharConsumer<T> action)

Description copied from interface: Object2CharMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Object2CharMap<T>

Parameters:

action - processor of the values that are iterator over

keySet

public ObjectSet<T> keySet()

Specified by:

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

Specified by:

keySet in interface Object2CharMap<T>

Overrides:

keySet in class java.util.AbstractMap<T,java.lang.Character>

values

public CharCollection values()

Specified by:

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

Specified by:

values in interface Object2CharMap<T>

Overrides:

values in class java.util.AbstractMap<T,java.lang.Character>

entrySet

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

Specified by:

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

Specified by:

entrySet in interface Object2CharMap<T>

Specified by:

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

equals

public boolean equals(java.lang.Object o)

Specified by:

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

Overrides:

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

hashCode

public int hashCode()

Specified by:

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

Overrides:

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