speiger.src.collections.ints.utils.maps

Class Int2DoubleMaps.UnmodifyableMap

java.lang.Object

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

speiger.src.collections.ints.maps.abstracts.AbstractInt2DoubleMap

speiger.src.collections.ints.utils.maps.Int2DoubleMaps.UnmodifyableMap

All Implemented Interfaces:

java.util.function.IntToDoubleFunction, java.util.Map<java.lang.Integer,java.lang.Double>, Int2DoubleFunction, Int2DoubleMap

Direct Known Subclasses:

Int2DoubleMaps.UnmodifyableSortedMap

Enclosing class:

Int2DoubleMaps

public static class Int2DoubleMaps.UnmodifyableMap
extends AbstractInt2DoubleMap
implements Int2DoubleMap

The Unmodifyable Map implementation that is sued for the unmodifyableMap function

Nested Class Summary

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

AbstractInt2DoubleMap.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.Int2DoubleMap

Int2DoubleMap.Entry, Int2DoubleMap.FastEntrySet

Method Summary

Modifier and Type	Method and Description
double	addTo(int key, double value) A Helper method to add a primitives together.
double	getDouble(int key) A Type Specific get method to reduce boxing/unboxing
double	getOrDefault(int key, double defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
ObjectSet<Int2DoubleMap.Entry>	int2DoubleEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
IntSet	keySet()
double	put(int key, double value) Type Specific method to reduce boxing/unboxing of values
double	putIfAbsent(int key, double value) Type Specific method to reduce boxing/unboxing of values
double	remInt(int key) Type Specific remove function to reduce boxing/unboxing
double	remIntOrDefault(int key, double defaultValue) Type-Specific Remove function with a default return value if wanted.
boolean	remove(int key, double value) Type Specific remove function to reduce boxing/unboxing
DoubleCollection	values()

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

addToAll, computeDouble, computeDoubleIfAbsent, computeDoubleIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, mergeAllDouble, mergeDouble, putAll, putAll, putAll, putAllIfAbsent, replace, replace, replaceDoubles, replaceDoubles, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, put, remove, 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.Int2DoubleMap

addToAll, compute, computeDouble, computeDoubleIfAbsent, computeDoubleIfPresent, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, getDefaultReturnValue, getOrDefault, merge, mergeAllDouble, mergeDouble, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, remove, remove, replace, replace, replace, replace, replaceAll, replaceDoubles, replaceDoubles, setDefaultReturnValue

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, putAll, size

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

applyAsDouble

Method Detail

put

public double put(int key,
                  double value)

Description copied from interface: Int2DoubleMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

put in interface Int2DoubleMap

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

Description copied from interface: Int2DoubleMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

putIfAbsent in interface Int2DoubleMap

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

Description copied from interface: Int2DoubleMap

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

Specified by:

addTo in interface Int2DoubleMap

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.

remInt

public double remInt(int key)

Description copied from interface: Int2DoubleMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remInt in interface Int2DoubleMap

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

remIntOrDefault

public double remIntOrDefault(int key,
                              double defaultValue)

Description copied from interface: Int2DoubleMap

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

Specified by:

remIntOrDefault in interface Int2DoubleMap

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

Description copied from interface: Int2DoubleMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Int2DoubleMap

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)

getDouble

public double getDouble(int key)

Description copied from interface: Int2DoubleMap

A Type Specific get method to reduce boxing/unboxing

Specified by:

getDouble in interface Int2DoubleFunction

Specified by:

getDouble in interface Int2DoubleMap

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

getOrDefault

public double getOrDefault(int key,
                           double defaultValue)

Description copied from interface: Int2DoubleMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Int2DoubleMap

Overrides:

getOrDefault in class AbstractInt2DoubleMap

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

keySet

public IntSet keySet()

Specified by:

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

Specified by:

keySet in interface Int2DoubleMap

Overrides:

keySet in class AbstractInt2DoubleMap

values

public DoubleCollection values()

Specified by:

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

Specified by:

values in interface Int2DoubleMap

Overrides:

values in class AbstractInt2DoubleMap

int2DoubleEntrySet

public ObjectSet<Int2DoubleMap.Entry> int2DoubleEntrySet()

Description copied from interface: Int2DoubleMap

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

Specified by:

int2DoubleEntrySet in interface Int2DoubleMap

Returns:

a EntrySet of the collection