speiger.src.collections.objects.utils.maps

Class Object2ShortMaps.UnmodifyableMap<T>

java.lang.Object

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

speiger.src.collections.objects.maps.abstracts.AbstractObject2ShortMap<T>

speiger.src.collections.objects.utils.maps.Object2ShortMaps.UnmodifyableMap<T>

Type Parameters:

T - the keyType of elements maintained by this Collection

All Implemented Interfaces:

java.util.Map<T,java.lang.Short>, ToShortFunction<T>, Object2ShortMap<T>

Direct Known Subclasses:

Object2ShortMaps.UnmodifyableOrderedMap, Object2ShortMaps.UnmodifyableSortedMap

Enclosing class:

Object2ShortMaps

public static class Object2ShortMaps.UnmodifyableMap<T>
extends AbstractObject2ShortMap<T>
implements Object2ShortMap<T>

The Unmodifyable Map implementation that is sued for the unmodifyableMap function

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.objects.maps.abstracts.AbstractObject2ShortMap

AbstractObject2ShortMap.BasicEntry<T>

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.objects.maps.interfaces.Object2ShortMap

Object2ShortMap.BuilderCache<T>, Object2ShortMap.Entry<T>, Object2ShortMap.FastEntrySet<T>, Object2ShortMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
short	addTo(T key, short value) A Helper method to add a primitives together.
void	clear()
short	computeShort(T key, ObjectShortUnaryOperator<T> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
short	computeShortIfAbsent(T key, ToShortFunction<T> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
short	computeShortIfPresent(T key, ObjectShortUnaryOperator<T> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
Object2ShortMap<T>	copy() A Function that does a shallow clone of the Map itself.
short	getOrDefault(T key, short defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
short	getShort(T key) A Type Specific get method to reduce boxing/unboxing
ObjectSet<T>	keySet()
void	mergeAllShort(Object2ShortMap<T> m, ShortShortUnaryOperator mappingFunction) A Bulk method for merging Maps.
short	mergeShort(T key, short value, ShortShortUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
ObjectSet<Object2ShortMap.Entry<T>>	object2ShortEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
short	put(T key, short value) Type Specific method to reduce boxing/unboxing of values
short	putIfAbsent(T key, short value) Type Specific method to reduce boxing/unboxing of values
short	rem(T key) Type Specific remove function to reduce boxing/unboxing
short	remOrDefault(T key, short defaultValue) Type-Specific Remove function with a default return value if wanted.
boolean	remove(T key, short value) Type Specific remove function to reduce boxing/unboxing
void	replaceShorts(Object2ShortMap<T> m) Type-Specific bulk replace method.
void	replaceShorts(ObjectShortUnaryOperator<T> mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
short	subFrom(T key, short value) A Helper method to subtract from primitive from each other.
short	supplyShortIfAbsent(T key, ShortSupplier valueProvider) A Supplier based computeIfAbsent function to fill the most used usecase of this function
ShortCollection	values()

Methods inherited from class speiger.src.collections.objects.maps.abstracts.AbstractObject2ShortMap

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

containsValue, isEmpty, size, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2ShortMap

addToAll, applyAsShort, builder, compute, computeIfAbsent, computeIfPresent, 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

containsKey, equals, hashCode, isEmpty, putAll, size

Method Detail

put

public short put(T key,
                 short value)

Description copied from interface: Object2ShortMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

put in interface Object2ShortMap<T>

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

Description copied from interface: Object2ShortMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

putIfAbsent in interface Object2ShortMap<T>

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

Description copied from interface: Object2ShortMap

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

Specified by:

addTo in interface Object2ShortMap<T>

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

Description copied from interface: Object2ShortMap

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

Specified by:

subFrom in interface Object2ShortMap<T>

Parameters:

key - that should be subtract from

value - that should be subtract

Returns:

the last present or default return value

rem

public short rem(T key)

Description copied from interface: Object2ShortMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

rem in interface Object2ShortMap<T>

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

remOrDefault

public short remOrDefault(T key,
                          short defaultValue)

Description copied from interface: Object2ShortMap

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

Specified by:

remOrDefault in interface Object2ShortMap<T>

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

Description copied from interface: Object2ShortMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Object2ShortMap<T>

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)

getShort

public short getShort(T key)

Description copied from interface: Object2ShortMap

A Type Specific get method to reduce boxing/unboxing

Specified by:

getShort in interface Object2ShortMap<T>

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

getOrDefault

public short getOrDefault(T key,
                          short defaultValue)

Description copied from interface: Object2ShortMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Object2ShortMap<T>

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

computeShort

public short computeShort(T key,
                          ObjectShortUnaryOperator<T> mappingFunction)

Description copied from interface: Object2ShortMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeShort in interface Object2ShortMap<T>

Overrides:

computeShort in class AbstractObject2ShortMap<T>

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeShortIfAbsent

public short computeShortIfAbsent(T key,
                                  ToShortFunction<T> mappingFunction)

Description copied from interface: Object2ShortMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeShortIfAbsent in interface Object2ShortMap<T>

Overrides:

computeShortIfAbsent in class AbstractObject2ShortMap<T>

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

computeShortIfPresent

public short computeShortIfPresent(T key,
                                   ObjectShortUnaryOperator<T> mappingFunction)

Description copied from interface: Object2ShortMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeShortIfPresent in interface Object2ShortMap<T>

Overrides:

computeShortIfPresent in class AbstractObject2ShortMap<T>

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

supplyShortIfAbsent

public short supplyShortIfAbsent(T key,
                                 ShortSupplier valueProvider)

Description copied from interface: Object2ShortMap

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

Specified by:

supplyShortIfAbsent in interface Object2ShortMap<T>

Overrides:

supplyShortIfAbsent in class AbstractObject2ShortMap<T>

Parameters:

key - the key that should be computed

valueProvider - the value if not present

Returns:

the result of the computed value or present value

mergeShort

public short mergeShort(T key,
                        short value,
                        ShortShortUnaryOperator mappingFunction)

Description copied from interface: Object2ShortMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeShort in interface Object2ShortMap<T>

Overrides:

mergeShort in class AbstractObject2ShortMap<T>

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

mergeAllShort

public void mergeAllShort(Object2ShortMap<T> m,
                          ShortShortUnaryOperator mappingFunction)

Description copied from interface: Object2ShortMap

A Bulk method for merging Maps.

Specified by:

mergeAllShort in interface Object2ShortMap<T>

Overrides:

mergeAllShort in class AbstractObject2ShortMap<T>

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

replaceShorts

public void replaceShorts(ObjectShortUnaryOperator<T> mappingFunction)

Description copied from interface: Object2ShortMap

A Type Specific mass replace method to reduce boxing/unboxing

Specified by:

replaceShorts in interface Object2ShortMap<T>

Overrides:

replaceShorts in class AbstractObject2ShortMap<T>

Parameters:

mappingFunction - operation to replace all values

replaceShorts

public void replaceShorts(Object2ShortMap<T> m)

Description copied from interface: Object2ShortMap

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

Specified by:

replaceShorts in interface Object2ShortMap<T>

Overrides:

replaceShorts in class AbstractObject2ShortMap<T>

Parameters:

m - elements that should be replaced.

copy

public Object2ShortMap<T> copy()

Description copied from interface: Object2ShortMap

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 Object2ShortMap<T>

Overrides:

copy in class AbstractObject2ShortMap<T>

Returns:

a Shallow Copy of the Map

clear

public void clear()

Specified by:

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

Overrides:

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

keySet

public ObjectSet<T> keySet()

Specified by:

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

Specified by:

keySet in interface Object2ShortMap<T>

Overrides:

keySet in class AbstractObject2ShortMap<T>

values

public ShortCollection values()

Specified by:

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

Specified by:

values in interface Object2ShortMap<T>

Overrides:

values in class AbstractObject2ShortMap<T>

object2ShortEntrySet

public ObjectSet<Object2ShortMap.Entry<T>> object2ShortEntrySet()

Description copied from interface: Object2ShortMap

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

Specified by:

object2ShortEntrySet in interface Object2ShortMap<T>

Returns:

a EntrySet of the collection