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.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.Entry, Short2DoubleMap.FastEntrySet

Method Summary

Modifier and Type	Method and Description
double	addTo(short key, double value) A Helper method to add a primitives together.
double	getDouble(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()
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
boolean	remove(short key, double value) Type Specific remove function to reduce boxing/unboxing
double	remShort(short key) Type Specific remove function to reduce boxing/unboxing
double	remShortOrDefault(short key, double defaultValue) Type-Specific Remove function with a default return value if wanted.
ObjectSet<Short2DoubleMap.Entry>	short2DoubleEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
DoubleCollection	values()

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

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

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

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.

remShort

public double remShort(short key)

Description copied from interface: Short2DoubleMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remShort in interface Short2DoubleMap

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

remShortOrDefault

public double remShortOrDefault(short key,
                                double defaultValue)

Description copied from interface: Short2DoubleMap

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

Specified by:

remShortOrDefault 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)

getDouble

public double getDouble(short key)

Description copied from interface: Short2DoubleMap

A Type Specific get method to reduce boxing/unboxing

Specified by:

getDouble in interface Short2DoubleFunction

Specified by:

getDouble 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

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