speiger.src.collections.shorts.utils.maps

Class Short2DoubleMaps.UnmodifyableMap

java.lang.Object

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

speiger.src.collections.shorts.maps.abstracts.AbstractShort2DoubleMap

speiger.src.collections.shorts.utils.maps.Short2DoubleMaps.UnmodifyableMap

All Implemented Interfaces:

java.util.Map<java.lang.Short,java.lang.Double>, Short2DoubleFunction, Short2DoubleMap

Direct Known Subclasses:

Short2DoubleMaps.UnmodifyableOrderedMap, Short2DoubleMaps.UnmodifyableSortedMap

Enclosing class:

Short2DoubleMaps

public static class Short2DoubleMaps.UnmodifyableMap
extends AbstractShort2DoubleMap
implements Short2DoubleMap

The Unmodifyable Map implementation that is sued for the unmodifyableMap function

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.shorts.maps.abstracts.AbstractShort2DoubleMap

AbstractShort2DoubleMap.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.shorts.maps.interfaces.Short2DoubleMap

Short2DoubleMap.BuilderCache, Short2DoubleMap.Entry, Short2DoubleMap.FastEntrySet, Short2DoubleMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
double	addTo(short key, double value) A Helper method to add a primitives together.
void	clear()
double	computeDouble(short key, ShortDoubleUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
double	computeDoubleIfAbsent(short key, Short2DoubleFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
double	computeDoubleIfPresent(short key, ShortDoubleUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
Short2DoubleMap	copy() A Function that does a shallow clone of the Map itself.
double	get(short key) A Type Specific get method to reduce boxing/unboxing
double	getOrDefault(short key, double defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
ShortSet	keySet()
void	mergeAllDouble(Short2DoubleMap m, DoubleDoubleUnaryOperator mappingFunction) A Bulk method for merging Maps.
double	mergeDouble(short key, double value, DoubleDoubleUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
double	put(short key, double value) Type Specific method to reduce boxing/unboxing of values
double	putIfAbsent(short key, double value) Type Specific method to reduce boxing/unboxing of values
double	remove(short key) Type Specific remove function to reduce boxing/unboxing
boolean	remove(short key, double value) Type Specific remove function to reduce boxing/unboxing
double	removeOrDefault(short key, double defaultValue) Type-Specific Remove function with a default return value if wanted.
void	replaceDoubles(Short2DoubleMap m) Type-Specific bulk replace method.
void	replaceDoubles(ShortDoubleUnaryOperator mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
ObjectSet<Short2DoubleMap.Entry>	short2DoubleEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
double	subFrom(short key, double value) A Helper method to subtract from primitive from each other.
double	supplyDoubleIfAbsent(short key, DoubleSupplier valueProvider) A Supplier based computeIfAbsent function to fill the most used usecase of this function
DoubleCollection	values()

Methods inherited from class speiger.src.collections.shorts.maps.abstracts.AbstractShort2DoubleMap

addToAll, 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, containsValue, isEmpty, size, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2DoubleMap

addToAll, builder, compute, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, getDefaultReturnValue, getOrDefault, merge, 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

equals, hashCode, isEmpty, putAll, size

Method Detail

put

public double put(short key,
                  double value)

Description copied from interface: Short2DoubleMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

put in interface Short2DoubleMap

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

Description copied from interface: Short2DoubleMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

putIfAbsent in interface Short2DoubleMap

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

Description copied from interface: Short2DoubleMap

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

Specified by:

addTo in interface Short2DoubleMap

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 double subFrom(short key,
                      double value)

Description copied from interface: Short2DoubleMap

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 Short2DoubleMap.getDefaultReturnValue() If the fence is reached the element will be automaticall removed

Specified by:

subFrom in interface Short2DoubleMap

Parameters:

key - that should be subtract from

value - that should be subtract

Returns:

the last present or default return value

remove

public double remove(short key)

Description copied from interface: Short2DoubleMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Short2DoubleMap

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

removeOrDefault

public double removeOrDefault(short key,
                              double defaultValue)

Description copied from interface: Short2DoubleMap

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

Specified by:

removeOrDefault in interface Short2DoubleMap

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

Description copied from interface: Short2DoubleMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Short2DoubleMap

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

Description copied from interface: Short2DoubleMap

A Type Specific get method to reduce boxing/unboxing

Specified by:

get in interface Short2DoubleFunction

Specified by:

get in interface Short2DoubleMap

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

getOrDefault

public double getOrDefault(short key,
                           double defaultValue)

Description copied from interface: Short2DoubleMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Short2DoubleMap

Overrides:

getOrDefault in class AbstractShort2DoubleMap

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

computeDouble

public double computeDouble(short key,
                            ShortDoubleUnaryOperator mappingFunction)

Description copied from interface: Short2DoubleMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeDouble in interface Short2DoubleMap

Overrides:

computeDouble in class AbstractShort2DoubleMap

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeDoubleIfAbsent

public double computeDoubleIfAbsent(short key,
                                    Short2DoubleFunction mappingFunction)

Description copied from interface: Short2DoubleMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeDoubleIfAbsent in interface Short2DoubleMap

Overrides:

computeDoubleIfAbsent in class AbstractShort2DoubleMap

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

computeDoubleIfPresent

public double computeDoubleIfPresent(short key,
                                     ShortDoubleUnaryOperator mappingFunction)

Description copied from interface: Short2DoubleMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeDoubleIfPresent in interface Short2DoubleMap

Overrides:

computeDoubleIfPresent in class AbstractShort2DoubleMap

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

supplyDoubleIfAbsent

public double supplyDoubleIfAbsent(short key,
                                   DoubleSupplier valueProvider)

Description copied from interface: Short2DoubleMap

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

Specified by:

supplyDoubleIfAbsent in interface Short2DoubleMap

Overrides:

supplyDoubleIfAbsent in class AbstractShort2DoubleMap

Parameters:

key - the key that should be computed

valueProvider - the value if not present

Returns:

the result of the computed value or present value

mergeDouble

public double mergeDouble(short key,
                          double value,
                          DoubleDoubleUnaryOperator mappingFunction)

Description copied from interface: Short2DoubleMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeDouble in interface Short2DoubleMap

Overrides:

mergeDouble in class AbstractShort2DoubleMap

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

mergeAllDouble

public void mergeAllDouble(Short2DoubleMap m,
                           DoubleDoubleUnaryOperator mappingFunction)

Description copied from interface: Short2DoubleMap

A Bulk method for merging Maps.

Specified by:

mergeAllDouble in interface Short2DoubleMap

Overrides:

mergeAllDouble in class AbstractShort2DoubleMap

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

replaceDoubles

public void replaceDoubles(ShortDoubleUnaryOperator mappingFunction)

Description copied from interface: Short2DoubleMap

A Type Specific mass replace method to reduce boxing/unboxing

Specified by:

replaceDoubles in interface Short2DoubleMap

Overrides:

replaceDoubles in class AbstractShort2DoubleMap

Parameters:

mappingFunction - operation to replace all values

replaceDoubles

public void replaceDoubles(Short2DoubleMap m)

Description copied from interface: Short2DoubleMap

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

Specified by:

replaceDoubles in interface Short2DoubleMap

Overrides:

replaceDoubles in class AbstractShort2DoubleMap

Parameters:

m - elements that should be replaced.

copy

public Short2DoubleMap copy()

Description copied from interface: Short2DoubleMap

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 Short2DoubleMap

Overrides:

copy in class AbstractShort2DoubleMap

Returns:

a Shallow Copy of the Map

clear

public void clear()

Specified by:

clear in interface java.util.Map<java.lang.Short,java.lang.Double>

Overrides:

clear in class java.util.AbstractMap<java.lang.Short,java.lang.Double>

keySet

public ShortSet keySet()

Specified by:

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

Specified by:

keySet in interface Short2DoubleMap

Overrides:

keySet in class AbstractShort2DoubleMap

values

public DoubleCollection values()

Specified by:

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

Specified by:

values in interface Short2DoubleMap

Overrides:

values in class AbstractShort2DoubleMap

short2DoubleEntrySet

public ObjectSet<Short2DoubleMap.Entry> short2DoubleEntrySet()

Description copied from interface: Short2DoubleMap

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

Specified by:

short2DoubleEntrySet in interface Short2DoubleMap

Returns:

a EntrySet of the collection