speiger.src.collections.shorts.utils.maps

Class Short2LongMaps.UnmodifyableMap

java.lang.Object

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

speiger.src.collections.shorts.maps.abstracts.AbstractShort2LongMap

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

All Implemented Interfaces:

java.util.Map<java.lang.Short,java.lang.Long>, Short2LongFunction, Short2LongMap

Direct Known Subclasses:

Short2LongMaps.UnmodifyableOrderedMap, Short2LongMaps.UnmodifyableSortedMap

Enclosing class:

Short2LongMaps

public static class Short2LongMaps.UnmodifyableMap
extends AbstractShort2LongMap
implements Short2LongMap

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

AbstractShort2LongMap.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.Short2LongMap

Short2LongMap.BuilderCache, Short2LongMap.Entry, Short2LongMap.FastEntrySet, Short2LongMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
long	addTo(short key, long value) A Helper method to add a primitives together.
void	clear()
long	computeLong(short key, ShortLongUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
long	computeLongIfAbsent(short key, Short2LongFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
long	computeLongIfPresent(short key, ShortLongUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
Short2LongMap	copy() A Function that does a shallow clone of the Map itself.
long	get(short key) A Type Specific get method to reduce boxing/unboxing
long	getOrDefault(short key, long defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
ShortSet	keySet()
void	mergeAllLong(Short2LongMap m, LongLongUnaryOperator mappingFunction) A Bulk method for merging Maps.
long	mergeLong(short key, long value, LongLongUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
long	put(short key, long value) Type Specific method to reduce boxing/unboxing of values
long	putIfAbsent(short key, long value) Type Specific method to reduce boxing/unboxing of values
long	remove(short key) Type Specific remove function to reduce boxing/unboxing
boolean	remove(short key, long value) Type Specific remove function to reduce boxing/unboxing
long	removeOrDefault(short key, long defaultValue) Type-Specific Remove function with a default return value if wanted.
void	replaceLongs(Short2LongMap m) Type-Specific bulk replace method.
void	replaceLongs(ShortLongUnaryOperator mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
ObjectSet<Short2LongMap.Entry>	short2LongEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
long	subFrom(short key, long value) A Helper method to subtract from primitive from each other.
long	supplyLongIfAbsent(short key, LongSupplier valueProvider) A Supplier based computeIfAbsent function to fill the most used usecase of this function
LongCollection	values()

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

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

addToAll, applyAsLong, builder, compute, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, getDefaultReturnValue, getOrDefault, merge, put, put, 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 long put(short key,
                long value)

Description copied from interface: Short2LongMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

put in interface Short2LongMap

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

Description copied from interface: Short2LongMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

putIfAbsent in interface Short2LongMap

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

Description copied from interface: Short2LongMap

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

Specified by:

addTo in interface Short2LongMap

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

Description copied from interface: Short2LongMap

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

Specified by:

subFrom in interface Short2LongMap

Parameters:

key - that should be subtract from

value - that should be subtract

Returns:

the last present or default return value

remove

public long remove(short key)

Description copied from interface: Short2LongMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Short2LongMap

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

removeOrDefault

public long removeOrDefault(short key,
                            long defaultValue)

Description copied from interface: Short2LongMap

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

Specified by:

removeOrDefault in interface Short2LongMap

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

Description copied from interface: Short2LongMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Short2LongMap

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

Description copied from interface: Short2LongMap

A Type Specific get method to reduce boxing/unboxing

Specified by:

get in interface Short2LongMap

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

getOrDefault

public long getOrDefault(short key,
                         long defaultValue)

Description copied from interface: Short2LongMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Short2LongMap

Overrides:

getOrDefault in class AbstractShort2LongMap

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

computeLong

public long computeLong(short key,
                        ShortLongUnaryOperator mappingFunction)

Description copied from interface: Short2LongMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeLong in interface Short2LongMap

Overrides:

computeLong in class AbstractShort2LongMap

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeLongIfAbsent

public long computeLongIfAbsent(short key,
                                Short2LongFunction mappingFunction)

Description copied from interface: Short2LongMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeLongIfAbsent in interface Short2LongMap

Overrides:

computeLongIfAbsent in class AbstractShort2LongMap

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

computeLongIfPresent

public long computeLongIfPresent(short key,
                                 ShortLongUnaryOperator mappingFunction)

Description copied from interface: Short2LongMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeLongIfPresent in interface Short2LongMap

Overrides:

computeLongIfPresent in class AbstractShort2LongMap

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

supplyLongIfAbsent

public long supplyLongIfAbsent(short key,
                               LongSupplier valueProvider)

Description copied from interface: Short2LongMap

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

Specified by:

supplyLongIfAbsent in interface Short2LongMap

Overrides:

supplyLongIfAbsent in class AbstractShort2LongMap

Parameters:

key - the key that should be computed

valueProvider - the value if not present

Returns:

the result of the computed value or present value

mergeLong

public long mergeLong(short key,
                      long value,
                      LongLongUnaryOperator mappingFunction)

Description copied from interface: Short2LongMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeLong in interface Short2LongMap

Overrides:

mergeLong in class AbstractShort2LongMap

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

mergeAllLong

public void mergeAllLong(Short2LongMap m,
                         LongLongUnaryOperator mappingFunction)

Description copied from interface: Short2LongMap

A Bulk method for merging Maps.

Specified by:

mergeAllLong in interface Short2LongMap

Overrides:

mergeAllLong in class AbstractShort2LongMap

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

replaceLongs

public void replaceLongs(ShortLongUnaryOperator mappingFunction)

Description copied from interface: Short2LongMap

A Type Specific mass replace method to reduce boxing/unboxing

Specified by:

replaceLongs in interface Short2LongMap

Overrides:

replaceLongs in class AbstractShort2LongMap

Parameters:

mappingFunction - operation to replace all values

replaceLongs

public void replaceLongs(Short2LongMap m)

Description copied from interface: Short2LongMap

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

Specified by:

replaceLongs in interface Short2LongMap

Overrides:

replaceLongs in class AbstractShort2LongMap

Parameters:

m - elements that should be replaced.

copy

public Short2LongMap copy()

Description copied from interface: Short2LongMap

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 Short2LongMap

Overrides:

copy in class AbstractShort2LongMap

Returns:

a Shallow Copy of the Map

clear

public void clear()

Specified by:

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

Overrides:

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

keySet

public ShortSet keySet()

Specified by:

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

Specified by:

keySet in interface Short2LongMap

Overrides:

keySet in class AbstractShort2LongMap

values

public LongCollection values()

Specified by:

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

Specified by:

values in interface Short2LongMap

Overrides:

values in class AbstractShort2LongMap

short2LongEntrySet

public ObjectSet<Short2LongMap.Entry> short2LongEntrySet()

Description copied from interface: Short2LongMap

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

Specified by:

short2LongEntrySet in interface Short2LongMap

Returns:

a EntrySet of the collection