speiger.src.collections.chars.utils.maps

Class Char2ObjectMaps.UnmodifyableMap<V>

java.lang.Object

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

speiger.src.collections.chars.maps.abstracts.AbstractChar2ObjectMap<V>

speiger.src.collections.chars.utils.maps.Char2ObjectMaps.UnmodifyableMap<V>

Type Parameters:

V - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.Map<java.lang.Character,V>, Char2ObjectFunction<V>, Char2ObjectMap<V>

Direct Known Subclasses:

Char2ObjectMaps.UnmodifyableOrderedMap, Char2ObjectMaps.UnmodifyableSortedMap

Enclosing class:

Char2ObjectMaps

public static class Char2ObjectMaps.UnmodifyableMap<V>
extends AbstractChar2ObjectMap<V>
implements Char2ObjectMap<V>

The Unmodifyable Map implementation that is sued for the unmodifyableMap function

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.chars.maps.abstracts.AbstractChar2ObjectMap

AbstractChar2ObjectMap.BasicEntry<V>

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

Char2ObjectMap.BuilderCache<V>, Char2ObjectMap.Entry<V>, Char2ObjectMap.FastEntrySet<V>, Char2ObjectMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
ObjectSet<Char2ObjectMap.Entry<V>>	char2ObjectEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
void	clear()
V	compute(char key, CharObjectUnaryOperator<V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
V	computeIfAbsent(char key, Char2ObjectFunction<V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
V	computeIfPresent(char key, CharObjectUnaryOperator<V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
Char2ObjectMap<V>	copy() A Function that does a shallow clone of the Map itself.
V	get(char key) A Type Specific get method to reduce boxing/unboxing
V	getOrDefault(char key, V defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
CharSet	keySet()
V	merge(char key, V value, ObjectObjectUnaryOperator<V,V> mappingFunction) A Type Specific merge method to reduce boxing/unboxing
void	mergeAll(Char2ObjectMap<V> m, ObjectObjectUnaryOperator<V,V> mappingFunction) A Bulk method for merging Maps.
V	put(char key, V value) Type Specific method to reduce boxing/unboxing of values
V	putIfAbsent(char key, V value) Type Specific method to reduce boxing/unboxing of values
V	remove(char key) Type Specific remove function to reduce boxing/unboxing
boolean	remove(char key, V value) Type Specific remove function to reduce boxing/unboxing
V	removeOrDefault(char key, V defaultValue) Type-Specific Remove function with a default return value if wanted.
void	replaceObjects(Char2ObjectMap<V> m) Type-Specific bulk replace method.
void	replaceObjects(CharObjectUnaryOperator<V> mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
V	supplyIfAbsent(char key, ObjectSupplier<V> valueProvider) A Supplier based computeIfAbsent function to fill the most used usecase of this function
ObjectCollection<V>	values()

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

containsKey, containsValue, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, remove, replace, replace, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap

containsKey, 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.Char2ObjectMap

builder, compute, computeIfAbsent, computeIfPresent, containsKey, containsKey, entrySet, forEach, forEach, get, getDefaultReturnValue, getOrDefault, merge, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, remove, remove, replace, replace, replace, replace, replaceAll, setDefaultReturnValue, synchronize, synchronize, unmodifiable

Methods inherited from interface java.util.Map

containsValue, equals, hashCode, isEmpty, putAll, size

Method Detail

put

public V put(char key,
             V value)

Description copied from interface: Char2ObjectMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

put in interface Char2ObjectMap<V>

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

Description copied from interface: Char2ObjectMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

putIfAbsent in interface Char2ObjectMap<V>

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)

remove

public V remove(char key)

Description copied from interface: Char2ObjectMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Char2ObjectMap<V>

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

removeOrDefault

public V removeOrDefault(char key,
                         V defaultValue)

Description copied from interface: Char2ObjectMap

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

Specified by:

removeOrDefault in interface Char2ObjectMap<V>

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

Description copied from interface: Char2ObjectMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Char2ObjectMap<V>

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)

get

public V get(char key)

Description copied from interface: Char2ObjectMap

A Type Specific get method to reduce boxing/unboxing

Specified by:

get in interface Char2ObjectFunction<V>

Specified by:

get in interface Char2ObjectMap<V>

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

getOrDefault

public V getOrDefault(char key,
                      V defaultValue)

Description copied from interface: Char2ObjectMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Char2ObjectMap<V>

Overrides:

getOrDefault in class AbstractChar2ObjectMap<V>

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

compute

public V compute(char key,
                 CharObjectUnaryOperator<V> mappingFunction)

Description copied from interface: Char2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

compute in interface Char2ObjectMap<V>

Overrides:

compute in class AbstractChar2ObjectMap<V>

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeIfAbsent

public V computeIfAbsent(char key,
                         Char2ObjectFunction<V> mappingFunction)

Description copied from interface: Char2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIfAbsent in interface Char2ObjectMap<V>

Overrides:

computeIfAbsent in class AbstractChar2ObjectMap<V>

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

computeIfPresent

public V computeIfPresent(char key,
                          CharObjectUnaryOperator<V> mappingFunction)

Description copied from interface: Char2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIfPresent in interface Char2ObjectMap<V>

Overrides:

computeIfPresent in class AbstractChar2ObjectMap<V>

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

supplyIfAbsent

public V supplyIfAbsent(char key,
                        ObjectSupplier<V> valueProvider)

Description copied from interface: Char2ObjectMap

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

Specified by:

supplyIfAbsent in interface Char2ObjectMap<V>

Overrides:

supplyIfAbsent in class AbstractChar2ObjectMap<V>

Parameters:

key - the key that should be computed

valueProvider - the value if not present

Returns:

the result of the computed value or present value

merge

public V merge(char key,
               V value,
               ObjectObjectUnaryOperator<V,V> mappingFunction)

Description copied from interface: Char2ObjectMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

merge in interface Char2ObjectMap<V>

Overrides:

merge in class AbstractChar2ObjectMap<V>

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

mergeAll

public void mergeAll(Char2ObjectMap<V> m,
                     ObjectObjectUnaryOperator<V,V> mappingFunction)

Description copied from interface: Char2ObjectMap

A Bulk method for merging Maps.

Specified by:

mergeAll in interface Char2ObjectMap<V>

Overrides:

mergeAll in class AbstractChar2ObjectMap<V>

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

replaceObjects

public void replaceObjects(CharObjectUnaryOperator<V> mappingFunction)

Description copied from interface: Char2ObjectMap

A Type Specific mass replace method to reduce boxing/unboxing

Specified by:

replaceObjects in interface Char2ObjectMap<V>

Overrides:

replaceObjects in class AbstractChar2ObjectMap<V>

Parameters:

mappingFunction - operation to replace all values

replaceObjects

public void replaceObjects(Char2ObjectMap<V> m)

Description copied from interface: Char2ObjectMap

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

Specified by:

replaceObjects in interface Char2ObjectMap<V>

Overrides:

replaceObjects in class AbstractChar2ObjectMap<V>

Parameters:

m - elements that should be replaced.

copy

public Char2ObjectMap<V> copy()

Description copied from interface: Char2ObjectMap

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 Char2ObjectMap<V>

Overrides:

copy in class AbstractChar2ObjectMap<V>

Returns:

a Shallow Copy of the Map

clear

public void clear()

Specified by:

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

Overrides:

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

keySet

public CharSet keySet()

Specified by:

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

Specified by:

keySet in interface Char2ObjectMap<V>

Overrides:

keySet in class AbstractChar2ObjectMap<V>

values

public ObjectCollection<V> values()

Specified by:

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

Specified by:

values in interface Char2ObjectMap<V>

Overrides:

values in class AbstractChar2ObjectMap<V>

char2ObjectEntrySet

public ObjectSet<Char2ObjectMap.Entry<V>> char2ObjectEntrySet()

Description copied from interface: Char2ObjectMap

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

Specified by:

char2ObjectEntrySet in interface Char2ObjectMap<V>

Returns:

a EntrySet of the collection