speiger.src.collections.longs.utils.maps

Class Long2ObjectMaps.UnmodifyableMap<V>

java.lang.Object

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

speiger.src.collections.longs.maps.abstracts.AbstractLong2ObjectMap<V>

speiger.src.collections.longs.utils.maps.Long2ObjectMaps.UnmodifyableMap<V>

Type Parameters:

V - the keyType of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.LongFunction<V>, java.util.Map<java.lang.Long,V>, Long2ObjectMap<V>

Direct Known Subclasses:

Long2ObjectMaps.UnmodifyableOrderedMap, Long2ObjectMaps.UnmodifyableSortedMap

Enclosing class:

Long2ObjectMaps

public static class Long2ObjectMaps.UnmodifyableMap<V>
extends AbstractLong2ObjectMap<V>
implements Long2ObjectMap<V>

The Unmodifyable Map implementation that is sued for the unmodifyableMap function

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.longs.maps.abstracts.AbstractLong2ObjectMap

AbstractLong2ObjectMap.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.longs.maps.interfaces.Long2ObjectMap

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

Method Summary

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

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.longs.maps.interfaces.Long2ObjectMap

apply, builder, compute, computeIfAbsent, computeIfPresent, containsKey, containsKey, entrySet, forEach, forEach, get, getDefaultReturnValue, getOrDefault, merge, put, put, 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(long key,
             V value)

Description copied from interface: Long2ObjectMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

put in interface Long2ObjectMap<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(long key,
                     V value)

Description copied from interface: Long2ObjectMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

putIfAbsent in interface Long2ObjectMap<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(long key)

Description copied from interface: Long2ObjectMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Long2ObjectMap<V>

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

removeOrDefault

public V removeOrDefault(long key,
                         V defaultValue)

Description copied from interface: Long2ObjectMap

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

Specified by:

removeOrDefault in interface Long2ObjectMap<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(long key,
                      V value)

Description copied from interface: Long2ObjectMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Long2ObjectMap<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(long key)

Description copied from interface: Long2ObjectMap

A Type Specific get method to reduce boxing/unboxing

Specified by:

get in interface Long2ObjectMap<V>

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

getOrDefault

public V getOrDefault(long key,
                      V defaultValue)

Description copied from interface: Long2ObjectMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Long2ObjectMap<V>

Overrides:

getOrDefault in class AbstractLong2ObjectMap<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(long key,
                 LongObjectUnaryOperator<V> mappingFunction)

Description copied from interface: Long2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

compute in interface Long2ObjectMap<V>

Overrides:

compute in class AbstractLong2ObjectMap<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(long key,
                         LongFunction<V> mappingFunction)

Description copied from interface: Long2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIfAbsent in interface Long2ObjectMap<V>

Overrides:

computeIfAbsent in class AbstractLong2ObjectMap<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(long key,
                          LongObjectUnaryOperator<V> mappingFunction)

Description copied from interface: Long2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIfPresent in interface Long2ObjectMap<V>

Overrides:

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

Description copied from interface: Long2ObjectMap

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

Specified by:

supplyIfAbsent in interface Long2ObjectMap<V>

Overrides:

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

Description copied from interface: Long2ObjectMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

merge in interface Long2ObjectMap<V>

Overrides:

merge in class AbstractLong2ObjectMap<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(Long2ObjectMap<V> m,
                     ObjectObjectUnaryOperator<V,V> mappingFunction)

Description copied from interface: Long2ObjectMap

A Bulk method for merging Maps.

Specified by:

mergeAll in interface Long2ObjectMap<V>

Overrides:

mergeAll in class AbstractLong2ObjectMap<V>

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

replaceObjects

public void replaceObjects(LongObjectUnaryOperator<V> mappingFunction)

Description copied from interface: Long2ObjectMap

A Type Specific mass replace method to reduce boxing/unboxing

Specified by:

replaceObjects in interface Long2ObjectMap<V>

Overrides:

replaceObjects in class AbstractLong2ObjectMap<V>

Parameters:

mappingFunction - operation to replace all values

replaceObjects

public void replaceObjects(Long2ObjectMap<V> m)

Description copied from interface: Long2ObjectMap

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

Specified by:

replaceObjects in interface Long2ObjectMap<V>

Overrides:

replaceObjects in class AbstractLong2ObjectMap<V>

Parameters:

m - elements that should be replaced.

copy

public Long2ObjectMap<V> copy()

Description copied from interface: Long2ObjectMap

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

Overrides:

copy in class AbstractLong2ObjectMap<V>

Returns:

a Shallow Copy of the Map

clear

public void clear()

Specified by:

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

Overrides:

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

keySet

public LongSet keySet()

Specified by:

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

Specified by:

keySet in interface Long2ObjectMap<V>

Overrides:

keySet in class AbstractLong2ObjectMap<V>

values

public ObjectCollection<V> values()

Specified by:

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

Specified by:

values in interface Long2ObjectMap<V>

Overrides:

values in class AbstractLong2ObjectMap<V>

long2ObjectEntrySet

public ObjectSet<Long2ObjectMap.Entry<V>> long2ObjectEntrySet()

Description copied from interface: Long2ObjectMap

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

Specified by:

long2ObjectEntrySet in interface Long2ObjectMap<V>

Returns:

a EntrySet of the collection