speiger.src.collections.bytes.utils.maps

Class Byte2ShortMaps.UnmodifyableMap

java.lang.Object

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

speiger.src.collections.bytes.maps.abstracts.AbstractByte2ShortMap

speiger.src.collections.bytes.utils.maps.Byte2ShortMaps.UnmodifyableMap

All Implemented Interfaces:

java.util.Map<java.lang.Byte,java.lang.Short>, Byte2ShortFunction, Byte2ShortMap

Direct Known Subclasses:

Byte2ShortMaps.UnmodifyableOrderedMap, Byte2ShortMaps.UnmodifyableSortedMap

Enclosing class:

Byte2ShortMaps

public static class Byte2ShortMaps.UnmodifyableMap
extends AbstractByte2ShortMap
implements Byte2ShortMap

The Unmodifyable Map implementation that is sued for the unmodifyableMap function

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.bytes.maps.abstracts.AbstractByte2ShortMap

AbstractByte2ShortMap.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.bytes.maps.interfaces.Byte2ShortMap

Byte2ShortMap.BuilderCache, Byte2ShortMap.Entry, Byte2ShortMap.FastEntrySet, Byte2ShortMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
short	addTo(byte key, short value) A Helper method to add a primitives together.
ObjectSet<Byte2ShortMap.Entry>	byte2ShortEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
void	clear()
short	computeShort(byte key, ByteShortUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
short	computeShortIfAbsent(byte key, Byte2ShortFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
short	computeShortIfPresent(byte key, ByteShortUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
Byte2ShortMap	copy() A Function that does a shallow clone of the Map itself.
short	get(byte key) A Type Specific get method to reduce boxing/unboxing
short	getOrDefault(byte key, short defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
ByteSet	keySet()
void	mergeAllShort(Byte2ShortMap m, ShortShortUnaryOperator mappingFunction) A Bulk method for merging Maps.
short	mergeShort(byte key, short value, ShortShortUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
short	put(byte key, short value) Type Specific method to reduce boxing/unboxing of values
short	putIfAbsent(byte key, short value) Type Specific method to reduce boxing/unboxing of values
short	remove(byte key) Type Specific remove function to reduce boxing/unboxing
boolean	remove(byte key, short value) Type Specific remove function to reduce boxing/unboxing
short	removeOrDefault(byte key, short defaultValue) Type-Specific Remove function with a default return value if wanted.
void	replaceShorts(Byte2ShortMap m) Type-Specific bulk replace method.
void	replaceShorts(ByteShortUnaryOperator mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
short	subFrom(byte key, short value) A Helper method to subtract from primitive from each other.
short	supplyShortIfAbsent(byte 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.bytes.maps.abstracts.AbstractByte2ShortMap

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.bytes.maps.interfaces.Byte2ShortMap

addToAll, applyAsShort, 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 short put(byte key,
                 short value)

Description copied from interface: Byte2ShortMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

put in interface Byte2ShortMap

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

Description copied from interface: Byte2ShortMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

putIfAbsent in interface Byte2ShortMap

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

Description copied from interface: Byte2ShortMap

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

Specified by:

addTo in interface Byte2ShortMap

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

Description copied from interface: Byte2ShortMap

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

Specified by:

subFrom in interface Byte2ShortMap

Parameters:

key - that should be subtract from

value - that should be subtract

Returns:

the last present or default return value

remove

public short remove(byte key)

Description copied from interface: Byte2ShortMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Byte2ShortMap

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

removeOrDefault

public short removeOrDefault(byte key,
                             short defaultValue)

Description copied from interface: Byte2ShortMap

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

Specified by:

removeOrDefault in interface Byte2ShortMap

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

Description copied from interface: Byte2ShortMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Byte2ShortMap

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

Description copied from interface: Byte2ShortMap

A Type Specific get method to reduce boxing/unboxing

Specified by:

get in interface Byte2ShortMap

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

getOrDefault

public short getOrDefault(byte key,
                          short defaultValue)

Description copied from interface: Byte2ShortMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Byte2ShortMap

Overrides:

getOrDefault in class AbstractByte2ShortMap

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(byte key,
                          ByteShortUnaryOperator mappingFunction)

Description copied from interface: Byte2ShortMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeShort in interface Byte2ShortMap

Overrides:

computeShort in class AbstractByte2ShortMap

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(byte key,
                                  Byte2ShortFunction mappingFunction)

Description copied from interface: Byte2ShortMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeShortIfAbsent in interface Byte2ShortMap

Overrides:

computeShortIfAbsent in class AbstractByte2ShortMap

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(byte key,
                                   ByteShortUnaryOperator mappingFunction)

Description copied from interface: Byte2ShortMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeShortIfPresent in interface Byte2ShortMap

Overrides:

computeShortIfPresent in class AbstractByte2ShortMap

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(byte key,
                                 ShortSupplier valueProvider)

Description copied from interface: Byte2ShortMap

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

Specified by:

supplyShortIfAbsent in interface Byte2ShortMap

Overrides:

supplyShortIfAbsent in class AbstractByte2ShortMap

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(byte key,
                        short value,
                        ShortShortUnaryOperator mappingFunction)

Description copied from interface: Byte2ShortMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeShort in interface Byte2ShortMap

Overrides:

mergeShort in class AbstractByte2ShortMap

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(Byte2ShortMap m,
                          ShortShortUnaryOperator mappingFunction)

Description copied from interface: Byte2ShortMap

A Bulk method for merging Maps.

Specified by:

mergeAllShort in interface Byte2ShortMap

Overrides:

mergeAllShort in class AbstractByte2ShortMap

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

replaceShorts

public void replaceShorts(ByteShortUnaryOperator mappingFunction)

Description copied from interface: Byte2ShortMap

A Type Specific mass replace method to reduce boxing/unboxing

Specified by:

replaceShorts in interface Byte2ShortMap

Overrides:

replaceShorts in class AbstractByte2ShortMap

Parameters:

mappingFunction - operation to replace all values

replaceShorts

public void replaceShorts(Byte2ShortMap m)

Description copied from interface: Byte2ShortMap

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

Specified by:

replaceShorts in interface Byte2ShortMap

Overrides:

replaceShorts in class AbstractByte2ShortMap

Parameters:

m - elements that should be replaced.

copy

public Byte2ShortMap copy()

Description copied from interface: Byte2ShortMap

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 Byte2ShortMap

Overrides:

copy in class AbstractByte2ShortMap

Returns:

a Shallow Copy of the Map

clear

public void clear()

Specified by:

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

Overrides:

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

keySet

public ByteSet keySet()

Specified by:

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

Specified by:

keySet in interface Byte2ShortMap

Overrides:

keySet in class AbstractByte2ShortMap

values

public ShortCollection values()

Specified by:

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

Specified by:

values in interface Byte2ShortMap

Overrides:

values in class AbstractByte2ShortMap

byte2ShortEntrySet

public ObjectSet<Byte2ShortMap.Entry> byte2ShortEntrySet()

Description copied from interface: Byte2ShortMap

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

Specified by:

byte2ShortEntrySet in interface Byte2ShortMap

Returns:

a EntrySet of the collection