speiger.src.collections.ints.utils.maps

Class Int2ObjectMaps.EmptyMap<V>

java.lang.Object

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

speiger.src.collections.ints.maps.abstracts.AbstractInt2ObjectMap<V>

speiger.src.collections.ints.utils.maps.Int2ObjectMaps.EmptyMap<V>

Type Parameters:

V - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.IntFunction<V>, java.util.Map<java.lang.Integer,V>, Int2ObjectFunction<V>, Int2ObjectMap<V>

Enclosing class:

Int2ObjectMaps

public static class Int2ObjectMaps.EmptyMap<V>
extends AbstractInt2ObjectMap<V>

Empty Map impementation that is used for the emptyMap() function

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.ints.maps.abstracts.AbstractInt2ObjectMap

AbstractInt2ObjectMap.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.ints.maps.interfaces.Int2ObjectMap

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

Constructor Summary

Constructors

Constructor and Description
EmptyMap()

Method Summary

Modifier and Type	Method and Description
V	compute(int key, IntObjectUnaryOperator<V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
V	computeIfAbsent(int key, Int2ObjectFunction<V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
V	computeIfPresent(int key, IntObjectUnaryOperator<V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
Int2ObjectMaps.EmptyMap<V>	copy() A Function that does a shallow clone of the Map itself.
V	get(int key) A Type Specific get method to reduce boxing/unboxing
V	getOrDefault(int key, V defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
ObjectSet<Int2ObjectMap.Entry<V>>	int2ObjectEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
IntSet	keySet()
V	merge(int key, V value, ObjectObjectUnaryOperator<V,V> mappingFunction) A Type Specific merge method to reduce boxing/unboxing
void	mergeAll(Int2ObjectMap<V> m, ObjectObjectUnaryOperator<V,V> mappingFunction) A Bulk method for merging Maps.
V	put(int key, V value) Type Specific method to reduce boxing/unboxing of values
V	putIfAbsent(int key, V value) Type Specific method to reduce boxing/unboxing of values
V	remove(int key) Type Specific remove function to reduce boxing/unboxing
boolean	remove(int key, V value) Type Specific remove function to reduce boxing/unboxing
V	removeOrDefault(int key, V defaultValue) Type-Specific Remove function with a default return value if wanted.
V	supplyIfAbsent(int 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.ints.maps.abstracts.AbstractInt2ObjectMap

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

Methods inherited from class java.util.AbstractMap

clear, containsKey, isEmpty, size, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ObjectMap

builder, compute, computeIfAbsent, computeIfPresent, containsKey, forEach, merge, putAll, putAll, putIfAbsent, remove, replace, replace, replaceAll, synchronize, synchronize, unmodifiable

Methods inherited from interface java.util.Map

clear, isEmpty, size

Methods inherited from interface speiger.src.collections.ints.functions.function.Int2ObjectFunction

apply

Constructor Detail

EmptyMap

public EmptyMap()

Method Detail

put

public V put(int key,
             V value)

Description copied from interface: Int2ObjectMap

Type Specific method to reduce boxing/unboxing of values

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

Description copied from interface: Int2ObjectMap

Type Specific method to reduce boxing/unboxing of values

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(int key)

Description copied from interface: Int2ObjectMap

Type Specific remove function to reduce boxing/unboxing

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

removeOrDefault

public V removeOrDefault(int key,
                         V defaultValue)

Description copied from interface: Int2ObjectMap

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

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

Description copied from interface: Int2ObjectMap

Type Specific remove function to reduce boxing/unboxing

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(int key)

Description copied from interface: Int2ObjectMap

A Type Specific get method to reduce boxing/unboxing

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

getOrDefault

public V getOrDefault(int key,
                      V defaultValue)

Description copied from interface: Int2ObjectMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Int2ObjectMap<V>

Overrides:

getOrDefault in class AbstractInt2ObjectMap<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(int key,
                 IntObjectUnaryOperator<V> mappingFunction)

Description copied from interface: Int2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

compute in interface Int2ObjectMap<V>

Overrides:

compute in class AbstractInt2ObjectMap<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(int key,
                         Int2ObjectFunction<V> mappingFunction)

Description copied from interface: Int2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIfAbsent in interface Int2ObjectMap<V>

Overrides:

computeIfAbsent in class AbstractInt2ObjectMap<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(int key,
                          IntObjectUnaryOperator<V> mappingFunction)

Description copied from interface: Int2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIfPresent in interface Int2ObjectMap<V>

Overrides:

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

Description copied from interface: Int2ObjectMap

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

Specified by:

supplyIfAbsent in interface Int2ObjectMap<V>

Overrides:

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

Description copied from interface: Int2ObjectMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

merge in interface Int2ObjectMap<V>

Overrides:

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

Description copied from interface: Int2ObjectMap

A Bulk method for merging Maps.

Specified by:

mergeAll in interface Int2ObjectMap<V>

Overrides:

mergeAll in class AbstractInt2ObjectMap<V>

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

keySet

public IntSet keySet()

Specified by:

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

Specified by:

keySet in interface Int2ObjectMap<V>

Overrides:

keySet in class AbstractInt2ObjectMap<V>

values

public ObjectCollection<V> values()

Specified by:

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

Specified by:

values in interface Int2ObjectMap<V>

Overrides:

values in class AbstractInt2ObjectMap<V>

int2ObjectEntrySet

public ObjectSet<Int2ObjectMap.Entry<V>> int2ObjectEntrySet()

Description copied from interface: Int2ObjectMap

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

Returns:

a EntrySet of the collection

copy

public Int2ObjectMaps.EmptyMap<V> copy()

Description copied from interface: Int2ObjectMap

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

Overrides:

copy in class AbstractInt2ObjectMap<V>

Returns:

a Shallow Copy of the Map