speiger.src.collections.ints.utils.maps

Class Int2IntMaps.EmptyMap

java.lang.Object

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

speiger.src.collections.ints.maps.abstracts.AbstractInt2IntMap

speiger.src.collections.ints.utils.maps.Int2IntMaps.EmptyMap

All Implemented Interfaces:

java.util.function.IntUnaryOperator, java.util.Map<java.lang.Integer,java.lang.Integer>, Int2IntFunction, Int2IntMap

Enclosing class:

Int2IntMaps

public static class Int2IntMaps.EmptyMap
extends AbstractInt2IntMap

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

AbstractInt2IntMap.BasicEntry

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

Int2IntMap.BuilderCache, Int2IntMap.Entry, Int2IntMap.FastEntrySet, Int2IntMap.MapBuilder

Constructor Summary

Constructors

Constructor and Description
EmptyMap()

Method Summary

Modifier and Type	Method and Description
int	addTo(int key, int value) A Helper method to add a primitives together.
int	computeInt(int key, IntIntUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
int	computeIntIfAbsent(int key, Int2IntFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
int	computeIntIfPresent(int key, IntIntUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
Int2IntMaps.EmptyMap	copy() A Function that does a shallow clone of the Map itself.
int	get(int key) A Type Specific get method to reduce boxing/unboxing
int	getOrDefault(int key, int defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
ObjectSet<Int2IntMap.Entry>	int2IntEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
IntSet	keySet()
void	mergeAllInt(Int2IntMap m, IntIntUnaryOperator mappingFunction) A Bulk method for merging Maps.
int	mergeInt(int key, int value, IntIntUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
int	put(int key, int value) Type Specific method to reduce boxing/unboxing of values
int	putIfAbsent(int key, int value) Type Specific method to reduce boxing/unboxing of values
int	remove(int key) Type Specific remove function to reduce boxing/unboxing
boolean	remove(int key, int value) Type Specific remove function to reduce boxing/unboxing
int	removeOrDefault(int key, int defaultValue) Type-Specific Remove function with a default return value if wanted.
int	subFrom(int key, int value) A Helper method to subtract from primitive from each other.
int	supplyIntIfAbsent(int key, IntSupplier valueProvider) A Supplier based computeIfAbsent function to fill the most used usecase of this function
IntCollection	values()

Methods inherited from class speiger.src.collections.ints.maps.abstracts.AbstractInt2IntMap

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

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, 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.Int2IntMap

builder, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, 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.Int2IntFunction

applyAsInt

Methods inherited from interface java.util.function.IntUnaryOperator

andThen, compose, identity

Constructor Detail

EmptyMap

public EmptyMap()

Method Detail

put

public int put(int key,
               int value)

Description copied from interface: Int2IntMap

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

Description copied from interface: Int2IntMap

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)

addTo

public int addTo(int key,
                 int value)

Description copied from interface: Int2IntMap

A Helper method to add a primitives together. If key is not present then this functions as a put.

Parameters:

key - the key that should be inserted,

value - the value that should be inserted / added

Returns:

the last present value or default return value.

subFrom

public int subFrom(int key,
                   int value)

Description copied from interface: Int2IntMap

A Helper method to subtract from primitive from each other. If the key is not present it will just return the defaultValue How the implementation works is that it will subtract from the current value (if not present it will do nothing) and fence it to the Int2IntMap.getDefaultReturnValue() If the fence is reached the element will be automaticall removed

Parameters:

key - that should be subtract from

value - that should be subtract

Returns:

the last present or default return value

remove

public int remove(int key)

Description copied from interface: Int2IntMap

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

Description copied from interface: Int2IntMap

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

Description copied from interface: Int2IntMap

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

Description copied from interface: Int2IntMap

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

Description copied from interface: Int2IntMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Int2IntMap

Overrides:

getOrDefault in class AbstractInt2IntMap

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

computeInt

public int computeInt(int key,
                      IntIntUnaryOperator mappingFunction)

Description copied from interface: Int2IntMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeInt in interface Int2IntMap

Overrides:

computeInt in class AbstractInt2IntMap

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeIntIfAbsent

public int computeIntIfAbsent(int key,
                              Int2IntFunction mappingFunction)

Description copied from interface: Int2IntMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIntIfAbsent in interface Int2IntMap

Overrides:

computeIntIfAbsent in class AbstractInt2IntMap

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

computeIntIfPresent

public int computeIntIfPresent(int key,
                               IntIntUnaryOperator mappingFunction)

Description copied from interface: Int2IntMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIntIfPresent in interface Int2IntMap

Overrides:

computeIntIfPresent in class AbstractInt2IntMap

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

supplyIntIfAbsent

public int supplyIntIfAbsent(int key,
                             IntSupplier valueProvider)

Description copied from interface: Int2IntMap

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

Specified by:

supplyIntIfAbsent in interface Int2IntMap

Overrides:

supplyIntIfAbsent in class AbstractInt2IntMap

Parameters:

key - the key that should be computed

valueProvider - the value if not present

Returns:

the result of the computed value or present value

mergeInt

public int mergeInt(int key,
                    int value,
                    IntIntUnaryOperator mappingFunction)

Description copied from interface: Int2IntMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeInt in interface Int2IntMap

Overrides:

mergeInt in class AbstractInt2IntMap

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

mergeAllInt

public void mergeAllInt(Int2IntMap m,
                        IntIntUnaryOperator mappingFunction)

Description copied from interface: Int2IntMap

A Bulk method for merging Maps.

Specified by:

mergeAllInt in interface Int2IntMap

Overrides:

mergeAllInt in class AbstractInt2IntMap

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,java.lang.Integer>

Specified by:

keySet in interface Int2IntMap

Overrides:

keySet in class AbstractInt2IntMap

values

public IntCollection values()

Specified by:

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

Specified by:

values in interface Int2IntMap

Overrides:

values in class AbstractInt2IntMap

int2IntEntrySet

public ObjectSet<Int2IntMap.Entry> int2IntEntrySet()

Description copied from interface: Int2IntMap

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

Returns:

a EntrySet of the collection

copy

public Int2IntMaps.EmptyMap copy()

Description copied from interface: Int2IntMap

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 Int2IntMap

Overrides:

copy in class AbstractInt2IntMap

Returns:

a Shallow Copy of the Map