speiger.src.collections.objects.utils.maps

Class Object2ObjectMaps.UnmodifyableMap<T,V>

java.lang.Object

java.util.AbstractMap<T,V>

speiger.src.collections.objects.maps.abstracts.AbstractObject2ObjectMap<T,V>

speiger.src.collections.objects.utils.maps.Object2ObjectMaps.UnmodifyableMap<T,V>

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.Function<T,V>, java.util.Map<T,V>, Object2ObjectFunction<T,V>, Object2ObjectMap<T,V>

Direct Known Subclasses:

Object2ObjectMaps.UnmodifyableOrderedMap, Object2ObjectMaps.UnmodifyableSortedMap

Enclosing class:

Object2ObjectMaps

public static class Object2ObjectMaps.UnmodifyableMap<T,V>
extends AbstractObject2ObjectMap<T,V>
implements Object2ObjectMap<T,V>

The Unmodifyable Map implementation that is sued for the unmodifyableMap function

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.objects.maps.abstracts.AbstractObject2ObjectMap

AbstractObject2ObjectMap.BasicEntry<T,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.objects.maps.interfaces.Object2ObjectMap

Object2ObjectMap.BuilderCache<T,V>, Object2ObjectMap.Entry<T,V>, Object2ObjectMap.FastEntrySet<T,V>, Object2ObjectMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
void	clear()
V	compute(T key, ObjectObjectUnaryOperator<T,V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
V	computeIfAbsent(T key, Object2ObjectFunction<T,V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
V	computeIfPresent(T key, ObjectObjectUnaryOperator<T,V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
Object2ObjectMap<T,V>	copy() A Function that does a shallow clone of the Map itself.
V	getObject(T key) Type Specific get function to reduce boxing/unboxing
ObjectSet<T>	keySet()
V	merge(T key, V value, ObjectObjectUnaryOperator<V,V> mappingFunction) A Type Specific merge method to reduce boxing/unboxing
void	mergeAll(Object2ObjectMap<T,V> m, ObjectObjectUnaryOperator<V,V> mappingFunction) A Bulk method for merging Maps.
ObjectSet<Object2ObjectMap.Entry<T,V>>	object2ObjectEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
V	put(T key, V value) Type Specific method to reduce boxing/unboxing of values
V	putIfAbsent(T key, V value) Type Specific method to reduce boxing/unboxing of values
V	rem(T key) Type Specific remove function to reduce boxing/unboxing
V	remOrDefault(T key, V defaultValue) Type-Specific Remove function with a default return value if wanted.
void	replaceObjects(Object2ObjectMap<T,V> m) Type-Specific bulk replace method.
void	replaceObjects(ObjectObjectUnaryOperator<T,V> mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
V	supplyIfAbsent(T 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.objects.maps.abstracts.AbstractObject2ObjectMap

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

Methods inherited from class java.util.AbstractMap

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

builder, compute, computeIfAbsent, computeIfPresent, entrySet, forEach, forEach, getDefaultReturnValue, merge, putAll, putAll, putAll, putAllIfAbsent, remove, replace, replace, replaceAll, setDefaultReturnValue, synchronize, synchronize, unmodifiable

Methods inherited from interface java.util.Map

containsKey, containsValue, equals, get, getOrDefault, hashCode, isEmpty, putAll, remove, size

Methods inherited from interface speiger.src.collections.objects.functions.function.Object2ObjectFunction

apply

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Method Detail

put

public V put(T key,
             V value)

Description copied from interface: Object2ObjectMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

put in interface java.util.Map<T,V>

Specified by:

put in interface Object2ObjectMap<T,V>

Overrides:

put in class java.util.AbstractMap<T,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(T key,
                     V value)

Description copied from interface: Object2ObjectMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

putIfAbsent in interface java.util.Map<T,V>

Specified by:

putIfAbsent in interface Object2ObjectMap<T,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)

rem

public V rem(T key)

Description copied from interface: Object2ObjectMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

rem in interface Object2ObjectMap<T,V>

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

remOrDefault

public V remOrDefault(T key,
                      V defaultValue)

Description copied from interface: Object2ObjectMap

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

Specified by:

remOrDefault in interface Object2ObjectMap<T,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)

getObject

public V getObject(T key)

Description copied from interface: Object2ObjectFunction

Type Specific get function to reduce boxing/unboxing

Specified by:

getObject in interface Object2ObjectFunction<T,V>

Parameters:

key - the value that should be processed

Returns:

the result of the function

compute

public V compute(T key,
                 ObjectObjectUnaryOperator<T,V> mappingFunction)

Description copied from interface: Object2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

compute in interface Object2ObjectMap<T,V>

Overrides:

compute in class AbstractObject2ObjectMap<T,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(T key,
                         Object2ObjectFunction<T,V> mappingFunction)

Description copied from interface: Object2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIfAbsent in interface Object2ObjectMap<T,V>

Overrides:

computeIfAbsent in class AbstractObject2ObjectMap<T,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(T key,
                          ObjectObjectUnaryOperator<T,V> mappingFunction)

Description copied from interface: Object2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIfPresent in interface Object2ObjectMap<T,V>

Overrides:

computeIfPresent in class AbstractObject2ObjectMap<T,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(T key,
                        ObjectSupplier<V> valueProvider)

Description copied from interface: Object2ObjectMap

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

Specified by:

supplyIfAbsent in interface Object2ObjectMap<T,V>

Overrides:

supplyIfAbsent in class AbstractObject2ObjectMap<T,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(T key,
               V value,
               ObjectObjectUnaryOperator<V,V> mappingFunction)

Description copied from interface: Object2ObjectMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

merge in interface Object2ObjectMap<T,V>

Overrides:

merge in class AbstractObject2ObjectMap<T,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(Object2ObjectMap<T,V> m,
                     ObjectObjectUnaryOperator<V,V> mappingFunction)

Description copied from interface: Object2ObjectMap

A Bulk method for merging Maps.

Specified by:

mergeAll in interface Object2ObjectMap<T,V>

Overrides:

mergeAll in class AbstractObject2ObjectMap<T,V>

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

replaceObjects

public void replaceObjects(ObjectObjectUnaryOperator<T,V> mappingFunction)

Description copied from interface: Object2ObjectMap

A Type Specific mass replace method to reduce boxing/unboxing

Specified by:

replaceObjects in interface Object2ObjectMap<T,V>

Overrides:

replaceObjects in class AbstractObject2ObjectMap<T,V>

Parameters:

mappingFunction - operation to replace all values

replaceObjects

public void replaceObjects(Object2ObjectMap<T,V> m)

Description copied from interface: Object2ObjectMap

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

Specified by:

replaceObjects in interface Object2ObjectMap<T,V>

Overrides:

replaceObjects in class AbstractObject2ObjectMap<T,V>

Parameters:

m - elements that should be replaced.

copy

public Object2ObjectMap<T,V> copy()

Description copied from interface: Object2ObjectMap

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 Object2ObjectMap<T,V>

Overrides:

copy in class AbstractObject2ObjectMap<T,V>

Returns:

a Shallow Copy of the Map

clear

public void clear()

Specified by:

clear in interface java.util.Map<T,V>

Overrides:

clear in class java.util.AbstractMap<T,V>

keySet

public ObjectSet<T> keySet()

Specified by:

keySet in interface java.util.Map<T,V>

Specified by:

keySet in interface Object2ObjectMap<T,V>

Overrides:

keySet in class AbstractObject2ObjectMap<T,V>

values

public ObjectCollection<V> values()

Specified by:

values in interface java.util.Map<T,V>

Specified by:

values in interface Object2ObjectMap<T,V>

Overrides:

values in class AbstractObject2ObjectMap<T,V>

object2ObjectEntrySet

public ObjectSet<Object2ObjectMap.Entry<T,V>> object2ObjectEntrySet()

Description copied from interface: Object2ObjectMap

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

Specified by:

object2ObjectEntrySet in interface Object2ObjectMap<T,V>

Returns:

a EntrySet of the collection