ImmutableShort2ByteOpenHashMap (Primitive-Collections 0.7.0 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Short,java.lang.Byte>
- - speiger.src.collections.shorts.maps.abstracts.AbstractShort2ByteMap
  - - speiger.src.collections.shorts.maps.impl.immutable.ImmutableShort2ByteOpenHashMap

All Implemented Interfaces:

java.util.Map<java.lang.Short,java.lang.Byte>, Short2ByteFunction, Short2ByteMap, Short2ByteOrderedMap
```
public class ImmutableShort2ByteOpenHashMap
extends AbstractShort2ByteMap
implements Short2ByteOrderedMap
```
A Type Specific Custom implementation of the HashMap Instead of using Wrapper Object Arrays for storing keys and values there is dedicated arrays for storing keys and values. Extra to that there is a couple quality of life functions provided

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.Short2ByteOrderedMap
  Short2ByteOrderedMap.FastOrderedSet
- Nested classes/interfaces inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2ByteMap
  Short2ByteMap.BuilderCache, Short2ByteMap.Entry, Short2ByteMap.FastEntrySet, Short2ByteMap.MapBuilder

Constructor Summary

Constructors
Constructor and Description
`ImmutableShort2ByteOpenHashMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Byte> map)` A Helper constructor that allows to create a Map with exactly the same values as the provided map.
`ImmutableShort2ByteOpenHashMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Byte> map, float loadFactor)` A Helper constructor that allows to create a Map with exactly the same values as the provided map.
`ImmutableShort2ByteOpenHashMap(short[] keys, byte[] values)` Helper constructor that allow to create a map from unboxed values
`ImmutableShort2ByteOpenHashMap(java.lang.Short[] keys, java.lang.Byte[] values)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`ImmutableShort2ByteOpenHashMap(short[] keys, byte[] values, float loadFactor)` Helper constructor that allow to create a map from unboxed values
`ImmutableShort2ByteOpenHashMap(java.lang.Short[] keys, java.lang.Byte[] values, float loadFactor)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`ImmutableShort2ByteOpenHashMap(Short2ByteMap map)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`ImmutableShort2ByteOpenHashMap(Short2ByteMap map, float loadFactor)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
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
`boolean`	`containsKey(java.lang.Object key)` Deprecated.
`boolean`	`containsKey(short key)` Type Specific method to reduce boxing/unboxing of values
`boolean`	`containsValue(byte value)` Type Specific method to reduce boxing/unboxing of values
`boolean`	`containsValue(java.lang.Object value)` Deprecated.
`ImmutableShort2ByteOpenHashMap`	`copy()` A Function that does a shallow clone of the Map itself.
`byte`	`firstByteValue()` A method to get the first Value of a Map.
`short`	`firstShortKey()` A method to get the first Key of a Map.
`void`	`forEach(ShortByteConsumer action)` Type Specific forEach method to reduce boxing/unboxing
`java.lang.Byte`	`get(java.lang.Object key)`
`byte`	`get(short key)` A Type Specific get method to reduce boxing/unboxing
`byte`	`getAndMoveToFirst(short key)` A Specific get method that allows to move teh given key/value int the first index.
`byte`	`getAndMoveToLast(short key)` A Specific get method that allows to move teh given key/value int the last index.
`byte`	`getOrDefault(short key, byte defaultValue)` A Type Specific getOrDefault method to reduce boxing/unboxing
`ShortOrderedSet`	`keySet()`
`byte`	`lastByteValue()` A method to get the last Value of a Map.
`short`	`lastShortKey()` A method to get the last Key of a Map.
`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
`boolean`	`moveToFirst(short key)` A specific move method to move a given key/value to the first index.
`boolean`	`moveToLast(short key)` A specific move method to move a given key/value to the last index.
`short`	`pollFirstShortKey()` A method to get and remove the first Key of a Map.
`short`	`pollLastShortKey()` A method to get and remove the last Key of a Map.
`byte`	`put(short key, byte value)` Type Specific method to reduce boxing/unboxing of values
`byte`	`putAndMoveToFirst(short key, byte value)` A customized put method that allows you to insert into the first index.
`byte`	`putAndMoveToLast(short key, byte value)` A customized put method that allows you to insert into the last index.
`byte`	`putIfAbsent(short key, byte value)` Type Specific method to reduce boxing/unboxing of values
`java.lang.Byte`	`remove(java.lang.Object key)` Deprecated.
`boolean`	`remove(java.lang.Object key, java.lang.Object value)`
`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.
`byte`	`replace(short key, byte value)` A Type Specific replace method to reduce boxing/unboxing replace an existing value
`boolean`	`replace(short key, byte oldValue, byte newValue)` A Type Specific replace method to replace an existing value
`ObjectOrderedSet<Short2ByteMap.Entry>`	`short2ByteEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`int`	`size()`
`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, entrySet, equals, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, replaceBytes, replaceBytes, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap
isEmpty, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2ByteOrderedMap
synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2ByteMap
addToAll, builder, compute, computeIfAbsent, computeIfPresent, entrySet, forEach, getDefaultReturnValue, getOrDefault, merge, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, replace, replace, replaceAll, replaceBytes, replaceBytes, setDefaultReturnValue

Methods inherited from interface java.util.Map
equals, hashCode, isEmpty, putAll

- Constructor Detail
  - ImmutableShort2ByteOpenHashMap
```
public ImmutableShort2ByteOpenHashMap(java.lang.Short[] keys,
                                      java.lang.Byte[] values)
```
    Helper constructor that allow to create a map from boxed values (it will unbox them)
    
    Parameters:
    
    keys - the keys that should be put into the map
    
    values - the values that should be put into the map.
    
    Throws:
    
    java.lang.IllegalStateException - if the keys and values do not match in lenght
  - ImmutableShort2ByteOpenHashMap
```
public ImmutableShort2ByteOpenHashMap(java.lang.Short[] keys,
                                      java.lang.Byte[] values,
                                      float loadFactor)
```
    Helper constructor that allow to create a map from boxed values (it will unbox them)
    
    Parameters:
    
    keys - the keys that should be put into the map
    
    values - the values that should be put into the map.
    
    loadFactor - the percentage of how full the backing array can be before they resize
    
    Throws:
    
    java.lang.IllegalStateException - if the keys and values do not match in lenght
    
    java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1
  - ImmutableShort2ByteOpenHashMap
```
public ImmutableShort2ByteOpenHashMap(short[] keys,
                                      byte[] values)
```
    Helper constructor that allow to create a map from unboxed values
    
    Parameters:
    
    keys - the keys that should be put into the map
    
    values - the values that should be put into the map.
    
    Throws:
    
    java.lang.IllegalStateException - if the keys and values do not match in lenght
  - ImmutableShort2ByteOpenHashMap
```
public ImmutableShort2ByteOpenHashMap(short[] keys,
                                      byte[] values,
                                      float loadFactor)
```
    Helper constructor that allow to create a map from unboxed values
    
    Parameters:
    
    keys - the keys that should be put into the map
    
    values - the values that should be put into the map.
    
    loadFactor - the percentage of how full the backing array can be before they resize
    
    Throws:
    
    java.lang.IllegalStateException - if the keys and values do not match in lenght
    
    java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1
  - ImmutableShort2ByteOpenHashMap
```
public ImmutableShort2ByteOpenHashMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Byte> map)
```
    A Helper constructor that allows to create a Map with exactly the same values as the provided map.
    
    Parameters:
    
    map - the values that should be present in the map
  - ImmutableShort2ByteOpenHashMap
```
public ImmutableShort2ByteOpenHashMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Byte> map,
                                      float loadFactor)
```
    A Helper constructor that allows to create a Map with exactly the same values as the provided map.
    
    Parameters:
    
    map - the values that should be present in the map
    
    loadFactor - the percentage of how full the backing array can be before they resize
    
    Throws:
    
    java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1
  - ImmutableShort2ByteOpenHashMap
```
public ImmutableShort2ByteOpenHashMap(Short2ByteMap map)
```
    A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
    
    Parameters:
    
    map - the values that should be present in the map
  - ImmutableShort2ByteOpenHashMap
```
public ImmutableShort2ByteOpenHashMap(Short2ByteMap map,
                                      float loadFactor)
```
    A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
    
    Parameters:
    
    map - the values that should be present in the map
    
    loadFactor - the percentage of how full the backing array can be before they resize
    
    Throws:
    
    java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1
- 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
  - putAndMoveToFirst
```
public byte putAndMoveToFirst(short key,
                              byte value)
```
    Description copied from interface: Short2ByteOrderedMap
    
    A customized put method that allows you to insert into the first index.
    
    Specified by:
    
    putAndMoveToFirst in interface Short2ByteOrderedMap
    
    Parameters:
    
    key - the key that should be inserted
    
    value - the value that should be inserted
    
    Returns:
    
    the previous present or default return value
    
    See Also:
    
    Map.put(Object, Object)
  - putAndMoveToLast
```
public byte putAndMoveToLast(short key,
                             byte value)
```
    Description copied from interface: Short2ByteOrderedMap
    
    A customized put method that allows you to insert into the last index. (This may be nessesary depending on the implementation)
    
    Specified by:
    
    putAndMoveToLast in interface Short2ByteOrderedMap
    
    Parameters:
    
    key - the key that should be inserted
    
    value - the value that should be inserted
    
    Returns:
    
    the previous present or default return value
    
    See Also:
    
    Map.put(Object, Object)
  - moveToFirst
```
public boolean moveToFirst(short key)
```
    Description copied from interface: Short2ByteOrderedMap
    
    A specific move method to move a given key/value to the first index.
    
    Specified by:
    
    moveToFirst in interface Short2ByteOrderedMap
    
    Parameters:
    
    key - that should be moved to the first index
    
    Returns:
    
    true if the value was moved.
  - moveToLast
```
public boolean moveToLast(short key)
```
    Description copied from interface: Short2ByteOrderedMap
    
    A specific move method to move a given key/value to the last index.
    
    Specified by:
    
    moveToLast in interface Short2ByteOrderedMap
    
    Parameters:
    
    key - that should be moved to the first last
    
    Returns:
    
    true if the value was moved.
  - getAndMoveToFirst
```
public byte getAndMoveToFirst(short key)
```
    Description copied from interface: Short2ByteOrderedMap
    
    A Specific get method that allows to move teh given key/value int the first index.
    
    Specified by:
    
    getAndMoveToFirst in interface Short2ByteOrderedMap
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - getAndMoveToLast
```
public byte getAndMoveToLast(short key)
```
    Description copied from interface: Short2ByteOrderedMap
    
    A Specific get method that allows to move teh given key/value int the last index.
    
    Specified by:
    
    getAndMoveToLast in interface Short2ByteOrderedMap
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - containsKey
```
public boolean containsKey(short key)
```
    Description copied from interface: Short2ByteMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    containsKey in interface Short2ByteMap
    
    Overrides:
    
    containsKey in class AbstractShort2ByteMap
    
    Parameters:
    
    key - element that is searched for
    
    Returns:
    
    if the key is present
  - containsKey
```
@Deprecated
public boolean containsKey(java.lang.Object key)
```
    Deprecated.
    
    Specified by:
    
    containsKey in interface java.util.Map<java.lang.Short,java.lang.Byte>
    
    Specified by:
    
    containsKey in interface Short2ByteMap
    
    Overrides:
    
    containsKey in class java.util.AbstractMap<java.lang.Short,java.lang.Byte>
    
    Parameters:
    
    key - that is searched for.
    
    Returns:
    
    true if found
    
    See Also:
    
    Map.containsKey(Object)
  - containsValue
```
public boolean containsValue(byte value)
```
    Description copied from interface: Short2ByteMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    containsValue in interface Short2ByteMap
    
    Overrides:
    
    containsValue in class AbstractShort2ByteMap
    
    Parameters:
    
    value - element that is searched for
    
    Returns:
    
    if the value is present
  - containsValue
```
@Deprecated
public boolean containsValue(java.lang.Object value)
```
    Deprecated.
    
    Specified by:
    
    containsValue in interface java.util.Map<java.lang.Short,java.lang.Byte>
    
    Specified by:
    
    containsValue in interface Short2ByteMap
    
    Overrides:
    
    containsValue in class java.util.AbstractMap<java.lang.Short,java.lang.Byte>
    
    Parameters:
    
    value - that is searched for.
    
    Returns:
    
    true if found
    
    See Also:
    
    Map.containsValue(Object)
  - 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
```
@Deprecated
public java.lang.Byte remove(java.lang.Object key)
```
    Deprecated.
    
    Specified by:
    
    remove in interface java.util.Map<java.lang.Short,java.lang.Byte>
    
    Specified by:
    
    remove in interface Short2ByteMap
    
    Overrides:
    
    remove in class AbstractShort2ByteMap
    
    Parameters:
    
    key - the element that should be removed
    
    Returns:
    
    the value that was removed or default return value
    
    See Also:
    
    Map.remove(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)
  - remove
```
public boolean remove(java.lang.Object key,
                      java.lang.Object value)
```
    Specified by:
    
    remove in interface java.util.Map<java.lang.Short,java.lang.Byte>
    
    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
  - get
```
public java.lang.Byte get(java.lang.Object key)
```
    Specified by:
    
    get in interface java.util.Map<java.lang.Short,java.lang.Byte>
    
    Specified by:
    
    get in interface Short2ByteMap
    
    Overrides:
    
    get in class AbstractShort2ByteMap
  - 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
  - firstShortKey
```
public short firstShortKey()
```
    Description copied from interface: Short2ByteOrderedMap
    
    A method to get the first Key of a Map.
    
    Specified by:
    
    firstShortKey in interface Short2ByteOrderedMap
    
    Returns:
    
    the first key in the map
  - pollFirstShortKey
```
public short pollFirstShortKey()
```
    Description copied from interface: Short2ByteOrderedMap
    
    A method to get and remove the first Key of a Map.
    
    Specified by:
    
    pollFirstShortKey in interface Short2ByteOrderedMap
    
    Returns:
    
    the first key in the map
  - lastShortKey
```
public short lastShortKey()
```
    Description copied from interface: Short2ByteOrderedMap
    
    A method to get the last Key of a Map.
    
    Specified by:
    
    lastShortKey in interface Short2ByteOrderedMap
    
    Returns:
    
    the last key in the map
  - pollLastShortKey
```
public short pollLastShortKey()
```
    Description copied from interface: Short2ByteOrderedMap
    
    A method to get and remove the last Key of a Map.
    
    Specified by:
    
    pollLastShortKey in interface Short2ByteOrderedMap
    
    Returns:
    
    the last key in the map
  - firstByteValue
```
public byte firstByteValue()
```
    Description copied from interface: Short2ByteOrderedMap
    
    A method to get the first Value of a Map.
    
    Specified by:
    
    firstByteValue in interface Short2ByteOrderedMap
    
    Returns:
    
    the first key in the map
  - lastByteValue
```
public byte lastByteValue()
```
    Description copied from interface: Short2ByteOrderedMap
    
    A method to get the last Value of a Map.
    
    Specified by:
    
    lastByteValue in interface Short2ByteOrderedMap
    
    Returns:
    
    the last key in the map
  - short2ByteEntrySet
```
public ObjectOrderedSet<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
    
    Specified by:
    
    short2ByteEntrySet in interface Short2ByteOrderedMap
    
    Returns:
    
    a EntrySet of the collection
  - keySet
```
public ShortOrderedSet keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Short,java.lang.Byte>
    
    Specified by:
    
    keySet in interface Short2ByteMap
    
    Specified by:
    
    keySet in interface Short2ByteOrderedMap
    
    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
  - copy
```
public ImmutableShort2ByteOpenHashMap 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
    
    Specified by:
    
    copy in interface Short2ByteOrderedMap
    
    Overrides:
    
    copy in class AbstractShort2ByteMap
    
    Returns:
    
    a Shallow Copy of the Map
  - forEach
```
public void forEach(ShortByteConsumer action)
```
    Description copied from interface: Short2ByteMap
    
    Type Specific forEach method to reduce boxing/unboxing
    
    Specified by:
    
    forEach in interface Short2ByteMap
    
    Overrides:
    
    forEach in class AbstractShort2ByteMap
    
    Parameters:
    
    action - processor of the values that are iterator over
  - replace
```
public boolean replace(short key,
                       byte oldValue,
                       byte newValue)
```
    Description copied from interface: Short2ByteMap
    
    A Type Specific replace method to replace an existing value
    
    Specified by:
    
    replace in interface Short2ByteMap
    
    Overrides:
    
    replace in class AbstractShort2ByteMap
    
    Parameters:
    
    key - the element that should be searched for
    
    oldValue - the expected value to be replaced
    
    newValue - the value to replace the oldValue with.
    
    Returns:
    
    true if the value got replaced
  - replace
```
public byte replace(short key,
                    byte value)
```
    Description copied from interface: Short2ByteMap
    
    A Type Specific replace method to reduce boxing/unboxing replace an existing value
    
    Specified by:
    
    replace in interface Short2ByteMap
    
    Overrides:
    
    replace in class AbstractShort2ByteMap
    
    Parameters:
    
    key - the element that should be searched for
    
    value - the value to replace with.
    
    Returns:
    
    the present value or default return 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
  - 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
  - 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
  - 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
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Map<java.lang.Short,java.lang.Byte>
    
    Overrides:
    
    size in class java.util.AbstractMap<java.lang.Short,java.lang.Byte>
  - 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>

Class ImmutableShort2ByteOpenHashMap

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.shorts.maps.abstracts.AbstractShort2ByteMap

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2ByteOrderedMap

Nested classes/interfaces inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2ByteMap

Constructor Summary

Method Summary

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2ByteOrderedMap

Methods inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2ByteMap

Methods inherited from interface java.util.Map

Constructor Detail

ImmutableShort2ByteOpenHashMap

ImmutableShort2ByteOpenHashMap

ImmutableShort2ByteOpenHashMap

ImmutableShort2ByteOpenHashMap

ImmutableShort2ByteOpenHashMap

ImmutableShort2ByteOpenHashMap

ImmutableShort2ByteOpenHashMap

ImmutableShort2ByteOpenHashMap

Method Detail

put

putIfAbsent

addTo

subFrom

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

containsKey

containsKey

containsValue

containsValue

remove

removeOrDefault

remove

remove

remove

get

get

getOrDefault

firstShortKey

pollFirstShortKey

lastShortKey

pollLastShortKey

firstByteValue

lastByteValue

short2ByteEntrySet

keySet

values

copy

forEach

replace

replace

computeByte

computeByteIfAbsent

supplyByteIfAbsent

computeByteIfPresent

mergeByte

mergeAllByte

size

clear