speiger.src.collections.shorts.utils.maps

Class Short2ByteMaps.UnmodifyableMap

java.lang.Object

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

speiger.src.collections.shorts.maps.abstracts.AbstractShort2ByteMap

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

All Implemented Interfaces:

java.util.Map<java.lang.Short,java.lang.Byte>, Short2ByteFunction, Short2ByteMap

Direct Known Subclasses:

Short2ByteMaps.UnmodifyableOrderedMap, Short2ByteMaps.UnmodifyableSortedMap

Enclosing class:

Short2ByteMaps

public static class Short2ByteMaps.UnmodifyableMap
extends AbstractShort2ByteMap
implements Short2ByteMap

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

AbstractShort2ByteMap.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.Short2ByteMap

Short2ByteMap.BuilderCache, Short2ByteMap.Entry, Short2ByteMap.FastEntrySet, Short2ByteMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
byte	addTo(short key, byte value) A Helper method to add a primitives together.
void	clear()
byte	computeByte(short key, ShortByteUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
byte	computeByteIfAbsent(short key, Short2ByteFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
byte	computeByteIfPresent(short key, ShortByteUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
Short2ByteMap	copy() A Function that does a shallow clone of the Map itself.
byte	get(short key) A Type Specific get method to reduce boxing/unboxing
byte	getOrDefault(short key, byte defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
ShortSet	keySet()
void	mergeAllByte(Short2ByteMap m, ByteByteUnaryOperator mappingFunction) A Bulk method for merging Maps.
byte	mergeByte(short key, byte value, ByteByteUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
byte	put(short key, byte value) Type Specific method to reduce boxing/unboxing of values
byte	putIfAbsent(short key, byte value) Type Specific method to reduce boxing/unboxing of values
byte	remove(short key) Type Specific remove function to reduce boxing/unboxing
boolean	remove(short key, byte value) Type Specific remove function to reduce boxing/unboxing
byte	removeOrDefault(short key, byte defaultValue) Type-Specific Remove function with a default return value if wanted.
void	replaceBytes(Short2ByteMap m) Type-Specific bulk replace method.
void	replaceBytes(ShortByteUnaryOperator mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
ObjectSet<Short2ByteMap.Entry>	short2ByteEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
byte	subFrom(short key, byte value) A Helper method to subtract from primitive from each other.
byte	supplyByteIfAbsent(short key, ByteSupplier valueProvider) A Supplier based computeIfAbsent function to fill the most used usecase of this function
ByteCollection	values()

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

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

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

Description copied from interface: Short2ByteMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

put in interface Short2ByteMap

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

Description copied from interface: Short2ByteMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

putIfAbsent in interface Short2ByteMap

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

Description copied from interface: Short2ByteMap

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

Specified by:

addTo in interface Short2ByteMap

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

Description copied from interface: Short2ByteMap

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

Specified by:

subFrom in interface Short2ByteMap

Parameters:

key - that should be subtract from

value - that should be subtract

Returns:

the last present or default return value

remove

public byte remove(short key)

Description copied from interface: Short2ByteMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Short2ByteMap

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

removeOrDefault

public byte removeOrDefault(short key,
                            byte defaultValue)

Description copied from interface: Short2ByteMap

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

Specified by:

removeOrDefault in interface Short2ByteMap

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

Description copied from interface: Short2ByteMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Short2ByteMap

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

Description copied from interface: Short2ByteMap

A Type Specific get method to reduce boxing/unboxing

Specified by:

get in interface Short2ByteFunction

Specified by:

get in interface Short2ByteMap

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

getOrDefault

public byte getOrDefault(short key,
                         byte defaultValue)

Description copied from interface: Short2ByteMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Short2ByteMap

Overrides:

getOrDefault in class AbstractShort2ByteMap

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

computeByte

public byte computeByte(short key,
                        ShortByteUnaryOperator mappingFunction)

Description copied from interface: Short2ByteMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeByte in interface Short2ByteMap

Overrides:

computeByte in class AbstractShort2ByteMap

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeByteIfAbsent

public byte computeByteIfAbsent(short key,
                                Short2ByteFunction mappingFunction)

Description copied from interface: Short2ByteMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeByteIfAbsent in interface Short2ByteMap

Overrides:

computeByteIfAbsent in class AbstractShort2ByteMap

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

computeByteIfPresent

public byte computeByteIfPresent(short key,
                                 ShortByteUnaryOperator mappingFunction)

Description copied from interface: Short2ByteMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeByteIfPresent in interface Short2ByteMap

Overrides:

computeByteIfPresent in class AbstractShort2ByteMap

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

supplyByteIfAbsent

public byte supplyByteIfAbsent(short key,
                               ByteSupplier valueProvider)

Description copied from interface: Short2ByteMap

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

Specified by:

supplyByteIfAbsent in interface Short2ByteMap

Overrides:

supplyByteIfAbsent in class AbstractShort2ByteMap

Parameters:

key - the key that should be computed

valueProvider - the value if not present

Returns:

the result of the computed value or present value

mergeByte

public byte mergeByte(short key,
                      byte value,
                      ByteByteUnaryOperator mappingFunction)

Description copied from interface: Short2ByteMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeByte in interface Short2ByteMap

Overrides:

mergeByte in class AbstractShort2ByteMap

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

mergeAllByte

public void mergeAllByte(Short2ByteMap m,
                         ByteByteUnaryOperator mappingFunction)

Description copied from interface: Short2ByteMap

A Bulk method for merging Maps.

Specified by:

mergeAllByte in interface Short2ByteMap

Overrides:

mergeAllByte in class AbstractShort2ByteMap

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

replaceBytes

public void replaceBytes(ShortByteUnaryOperator mappingFunction)

Description copied from interface: Short2ByteMap

A Type Specific mass replace method to reduce boxing/unboxing

Specified by:

replaceBytes in interface Short2ByteMap

Overrides:

replaceBytes in class AbstractShort2ByteMap

Parameters:

mappingFunction - operation to replace all values

replaceBytes

public void replaceBytes(Short2ByteMap m)

Description copied from interface: Short2ByteMap

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

Specified by:

replaceBytes in interface Short2ByteMap

Overrides:

replaceBytes in class AbstractShort2ByteMap

Parameters:

m - elements that should be replaced.

copy

public Short2ByteMap copy()

Description copied from interface: Short2ByteMap

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 Short2ByteMap

Overrides:

copy in class AbstractShort2ByteMap

Returns:

a Shallow Copy of the Map

clear

public void clear()

Specified by:

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

Overrides:

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

keySet

public ShortSet keySet()

Specified by:

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

Specified by:

keySet in interface Short2ByteMap

Overrides:

keySet in class AbstractShort2ByteMap

values

public ByteCollection values()

Specified by:

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

Specified by:

values in interface Short2ByteMap

Overrides:

values in class AbstractShort2ByteMap

short2ByteEntrySet

public ObjectSet<Short2ByteMap.Entry> short2ByteEntrySet()

Description copied from interface: Short2ByteMap

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

Specified by:

short2ByteEntrySet in interface Short2ByteMap

Returns:

a EntrySet of the collection