ImmutableByte2IntOpenHashMap (Primitive-Collections 0.7.0 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Byte,java.lang.Integer>
- - speiger.src.collections.bytes.maps.abstracts.AbstractByte2IntMap
  - - speiger.src.collections.bytes.maps.impl.immutable.ImmutableByte2IntOpenHashMap

All Implemented Interfaces:

java.util.Map<java.lang.Byte,java.lang.Integer>, Byte2IntFunction, Byte2IntMap, Byte2IntOrderedMap
```
public class ImmutableByte2IntOpenHashMap
extends AbstractByte2IntMap
implements Byte2IntOrderedMap
```
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.bytes.maps.abstracts.AbstractByte2IntMap
  AbstractByte2IntMap.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.Byte2IntOrderedMap
  Byte2IntOrderedMap.FastOrderedSet
- Nested classes/interfaces inherited from interface speiger.src.collections.bytes.maps.interfaces.Byte2IntMap
  Byte2IntMap.BuilderCache, Byte2IntMap.Entry, Byte2IntMap.FastEntrySet, Byte2IntMap.MapBuilder

Constructor Summary

Constructors
Constructor and Description
`ImmutableByte2IntOpenHashMap(byte[] keys, int[] values)` Helper constructor that allow to create a map from unboxed values
`ImmutableByte2IntOpenHashMap(byte[] keys, int[] values, float loadFactor)` Helper constructor that allow to create a map from unboxed values
`ImmutableByte2IntOpenHashMap(java.lang.Byte[] keys, java.lang.Integer[] values)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`ImmutableByte2IntOpenHashMap(java.lang.Byte[] keys, java.lang.Integer[] values, float loadFactor)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`ImmutableByte2IntOpenHashMap(Byte2IntMap map)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`ImmutableByte2IntOpenHashMap(Byte2IntMap map, float loadFactor)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`ImmutableByte2IntOpenHashMap(java.util.Map<? extends java.lang.Byte,? extends java.lang.Integer> map)` A Helper constructor that allows to create a Map with exactly the same values as the provided map.
`ImmutableByte2IntOpenHashMap(java.util.Map<? extends java.lang.Byte,? extends java.lang.Integer> map, float loadFactor)` A Helper constructor that allows to create a 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
`int`	`addTo(byte key, int value)` A Helper method to add a primitives together.
`ObjectOrderedSet<Byte2IntMap.Entry>`	`byte2IntEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`void`	`clear()`
`int`	`computeInt(byte key, ByteIntUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`int`	`computeIntIfAbsent(byte key, Byte2IntFunction mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`int`	`computeIntIfPresent(byte key, ByteIntUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`boolean`	`containsKey(byte key)` Type Specific method to reduce boxing/unboxing of values
`boolean`	`containsKey(java.lang.Object key)` Deprecated.
`boolean`	`containsValue(int value)` Type Specific method to reduce boxing/unboxing of values
`boolean`	`containsValue(java.lang.Object value)` Deprecated.
`ImmutableByte2IntOpenHashMap`	`copy()` A Function that does a shallow clone of the Map itself.
`byte`	`firstByteKey()` A method to get the first Key of a Map.
`int`	`firstIntValue()` A method to get the first Value of a Map.
`void`	`forEach(ByteIntConsumer action)` Type Specific forEach method to reduce boxing/unboxing
`int`	`get(byte key)` A Type Specific get method to reduce boxing/unboxing
`java.lang.Integer`	`get(java.lang.Object key)`
`int`	`getAndMoveToFirst(byte key)` A Specific get method that allows to move teh given key/value int the first index.
`int`	`getAndMoveToLast(byte key)` A Specific get method that allows to move teh given key/value int the last index.
`int`	`getOrDefault(byte key, int defaultValue)` A Type Specific getOrDefault method to reduce boxing/unboxing
`ByteOrderedSet`	`keySet()`
`byte`	`lastByteKey()` A method to get the last Key of a Map.
`int`	`lastIntValue()` A method to get the last Value of a Map.
`void`	`mergeAllInt(Byte2IntMap m, IntIntUnaryOperator mappingFunction)` A Bulk method for merging Maps.
`int`	`mergeInt(byte key, int value, IntIntUnaryOperator mappingFunction)` A Type Specific merge method to reduce boxing/unboxing
`boolean`	`moveToFirst(byte key)` A specific move method to move a given key/value to the first index.
`boolean`	`moveToLast(byte key)` A specific move method to move a given key/value to the last index.
`byte`	`pollFirstByteKey()` A method to get and remove the first Key of a Map.
`byte`	`pollLastByteKey()` A method to get and remove the last Key of a Map.
`int`	`put(byte key, int value)` Type Specific method to reduce boxing/unboxing of values
`int`	`putAndMoveToFirst(byte key, int value)` A customized put method that allows you to insert into the first index.
`int`	`putAndMoveToLast(byte key, int value)` A customized put method that allows you to insert into the last index.
`int`	`putIfAbsent(byte key, int value)` Type Specific method to reduce boxing/unboxing of values
`int`	`remove(byte key)` Type Specific remove function to reduce boxing/unboxing
`boolean`	`remove(byte key, int value)` Type Specific remove function to reduce boxing/unboxing
`java.lang.Integer`	`remove(java.lang.Object key)` Deprecated.
`boolean`	`remove(java.lang.Object key, java.lang.Object value)`
`int`	`removeOrDefault(byte key, int defaultValue)` Type-Specific Remove function with a default return value if wanted.
`int`	`replace(byte key, int value)` A Type Specific replace method to reduce boxing/unboxing replace an existing value
`boolean`	`replace(byte key, int oldValue, int newValue)` A Type Specific replace method to replace an existing value
`int`	`size()`
`int`	`subFrom(byte key, int value)` A Helper method to subtract from primitive from each other.
`int`	`supplyIntIfAbsent(byte key, IntSupplier valueProvider)` A Supplier based computeIfAbsent function to fill the most used usecase of this function
`IntCollection`	`values()`

Methods inherited from class speiger.src.collections.bytes.maps.abstracts.AbstractByte2IntMap
addToAll, entrySet, equals, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, replaceInts, replaceInts, 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.bytes.maps.interfaces.Byte2IntOrderedMap
synchronize, synchronize, unmodifiable

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

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

- Constructor Detail
  - ImmutableByte2IntOpenHashMap
```
public ImmutableByte2IntOpenHashMap(java.lang.Byte[] keys,
                                    java.lang.Integer[] 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
  - ImmutableByte2IntOpenHashMap
```
public ImmutableByte2IntOpenHashMap(java.lang.Byte[] keys,
                                    java.lang.Integer[] 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
  - ImmutableByte2IntOpenHashMap
```
public ImmutableByte2IntOpenHashMap(byte[] keys,
                                    int[] 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
  - ImmutableByte2IntOpenHashMap
```
public ImmutableByte2IntOpenHashMap(byte[] keys,
                                    int[] 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
  - ImmutableByte2IntOpenHashMap
```
public ImmutableByte2IntOpenHashMap(java.util.Map<? extends java.lang.Byte,? extends java.lang.Integer> 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
  - ImmutableByte2IntOpenHashMap
```
public ImmutableByte2IntOpenHashMap(java.util.Map<? extends java.lang.Byte,? extends java.lang.Integer> 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
  - ImmutableByte2IntOpenHashMap
```
public ImmutableByte2IntOpenHashMap(Byte2IntMap 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
  - ImmutableByte2IntOpenHashMap
```
public ImmutableByte2IntOpenHashMap(Byte2IntMap 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 int put(byte key,
               int value)
```
    Description copied from interface: Byte2IntMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    put in interface Byte2IntMap
    
    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 int putIfAbsent(byte key,
                       int value)
```
    Description copied from interface: Byte2IntMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    putIfAbsent in interface Byte2IntMap
    
    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 int addTo(byte key,
                 int value)
```
    Description copied from interface: Byte2IntMap
    
    A Helper method to add a primitives together. If key is not present then this functions as a put.
    
    Specified by:
    
    addTo in interface Byte2IntMap
    
    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 int subFrom(byte key,
                   int value)
```
    Description copied from interface: Byte2IntMap
    
    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 Byte2IntMap.getDefaultReturnValue() If the fence is reached the element will be automaticall removed
    
    Specified by:
    
    subFrom in interface Byte2IntMap
    
    Parameters:
    
    key - that should be subtract from
    
    value - that should be subtract
    
    Returns:
    
    the last present or default return value
  - putAndMoveToFirst
```
public int putAndMoveToFirst(byte key,
                             int value)
```
    Description copied from interface: Byte2IntOrderedMap
    
    A customized put method that allows you to insert into the first index.
    
    Specified by:
    
    putAndMoveToFirst in interface Byte2IntOrderedMap
    
    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 int putAndMoveToLast(byte key,
                            int value)
```
    Description copied from interface: Byte2IntOrderedMap
    
    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 Byte2IntOrderedMap
    
    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(byte key)
```
    Description copied from interface: Byte2IntOrderedMap
    
    A specific move method to move a given key/value to the first index.
    
    Specified by:
    
    moveToFirst in interface Byte2IntOrderedMap
    
    Parameters:
    
    key - that should be moved to the first index
    
    Returns:
    
    true if the value was moved.
  - moveToLast
```
public boolean moveToLast(byte key)
```
    Description copied from interface: Byte2IntOrderedMap
    
    A specific move method to move a given key/value to the last index.
    
    Specified by:
    
    moveToLast in interface Byte2IntOrderedMap
    
    Parameters:
    
    key - that should be moved to the first last
    
    Returns:
    
    true if the value was moved.
  - getAndMoveToFirst
```
public int getAndMoveToFirst(byte key)
```
    Description copied from interface: Byte2IntOrderedMap
    
    A Specific get method that allows to move teh given key/value int the first index.
    
    Specified by:
    
    getAndMoveToFirst in interface Byte2IntOrderedMap
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - getAndMoveToLast
```
public int getAndMoveToLast(byte key)
```
    Description copied from interface: Byte2IntOrderedMap
    
    A Specific get method that allows to move teh given key/value int the last index.
    
    Specified by:
    
    getAndMoveToLast in interface Byte2IntOrderedMap
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - containsKey
```
public boolean containsKey(byte key)
```
    Description copied from interface: Byte2IntMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    containsKey in interface Byte2IntMap
    
    Overrides:
    
    containsKey in class AbstractByte2IntMap
    
    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.Byte,java.lang.Integer>
    
    Specified by:
    
    containsKey in interface Byte2IntMap
    
    Overrides:
    
    containsKey in class java.util.AbstractMap<java.lang.Byte,java.lang.Integer>
    
    Parameters:
    
    key - that is searched for.
    
    Returns:
    
    true if found
    
    See Also:
    
    Map.containsKey(Object)
  - containsValue
```
public boolean containsValue(int value)
```
    Description copied from interface: Byte2IntMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    containsValue in interface Byte2IntMap
    
    Overrides:
    
    containsValue in class AbstractByte2IntMap
    
    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.Byte,java.lang.Integer>
    
    Specified by:
    
    containsValue in interface Byte2IntMap
    
    Overrides:
    
    containsValue in class java.util.AbstractMap<java.lang.Byte,java.lang.Integer>
    
    Parameters:
    
    value - that is searched for.
    
    Returns:
    
    true if found
    
    See Also:
    
    Map.containsValue(Object)
  - remove
```
public int remove(byte key)
```
    Description copied from interface: Byte2IntMap
    
    Type Specific remove function to reduce boxing/unboxing
    
    Specified by:
    
    remove in interface Byte2IntMap
    
    Parameters:
    
    key - the element that should be removed
    
    Returns:
    
    the value that was removed or default return value
  - removeOrDefault
```
public int removeOrDefault(byte key,
                           int defaultValue)
```
    Description copied from interface: Byte2IntMap
    
    Type-Specific Remove function with a default return value if wanted.
    
    Specified by:
    
    removeOrDefault in interface Byte2IntMap
    
    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.Integer remove(java.lang.Object key)
```
    Deprecated.
    
    Specified by:
    
    remove in interface java.util.Map<java.lang.Byte,java.lang.Integer>
    
    Specified by:
    
    remove in interface Byte2IntMap
    
    Overrides:
    
    remove in class AbstractByte2IntMap
    
    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(byte key,
                      int value)
```
    Description copied from interface: Byte2IntMap
    
    Type Specific remove function to reduce boxing/unboxing
    
    Specified by:
    
    remove in interface Byte2IntMap
    
    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.Byte,java.lang.Integer>
    
    Specified by:
    
    remove in interface Byte2IntMap
    
    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 int get(byte key)
```
    Description copied from interface: Byte2IntMap
    
    A Type Specific get method to reduce boxing/unboxing
    
    Specified by:
    
    get in interface Byte2IntFunction
    
    Specified by:
    
    get in interface Byte2IntMap
    
    Parameters:
    
    key - the key that is searched for
    
    Returns:
    
    the searched value or default return value
  - get
```
public java.lang.Integer get(java.lang.Object key)
```
    Specified by:
    
    get in interface java.util.Map<java.lang.Byte,java.lang.Integer>
    
    Specified by:
    
    get in interface Byte2IntMap
    
    Overrides:
    
    get in class AbstractByte2IntMap
  - getOrDefault
```
public int getOrDefault(byte key,
                        int defaultValue)
```
    Description copied from interface: Byte2IntMap
    
    A Type Specific getOrDefault method to reduce boxing/unboxing
    
    Specified by:
    
    getOrDefault in interface Byte2IntMap
    
    Overrides:
    
    getOrDefault in class AbstractByte2IntMap
    
    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
  - firstByteKey
```
public byte firstByteKey()
```
    Description copied from interface: Byte2IntOrderedMap
    
    A method to get the first Key of a Map.
    
    Specified by:
    
    firstByteKey in interface Byte2IntOrderedMap
    
    Returns:
    
    the first key in the map
  - pollFirstByteKey
```
public byte pollFirstByteKey()
```
    Description copied from interface: Byte2IntOrderedMap
    
    A method to get and remove the first Key of a Map.
    
    Specified by:
    
    pollFirstByteKey in interface Byte2IntOrderedMap
    
    Returns:
    
    the first key in the map
  - lastByteKey
```
public byte lastByteKey()
```
    Description copied from interface: Byte2IntOrderedMap
    
    A method to get the last Key of a Map.
    
    Specified by:
    
    lastByteKey in interface Byte2IntOrderedMap
    
    Returns:
    
    the last key in the map
  - pollLastByteKey
```
public byte pollLastByteKey()
```
    Description copied from interface: Byte2IntOrderedMap
    
    A method to get and remove the last Key of a Map.
    
    Specified by:
    
    pollLastByteKey in interface Byte2IntOrderedMap
    
    Returns:
    
    the last key in the map
  - firstIntValue
```
public int firstIntValue()
```
    Description copied from interface: Byte2IntOrderedMap
    
    A method to get the first Value of a Map.
    
    Specified by:
    
    firstIntValue in interface Byte2IntOrderedMap
    
    Returns:
    
    the first key in the map
  - lastIntValue
```
public int lastIntValue()
```
    Description copied from interface: Byte2IntOrderedMap
    
    A method to get the last Value of a Map.
    
    Specified by:
    
    lastIntValue in interface Byte2IntOrderedMap
    
    Returns:
    
    the last key in the map
  - byte2IntEntrySet
```
public ObjectOrderedSet<Byte2IntMap.Entry> byte2IntEntrySet()
```
    Description copied from interface: Byte2IntMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Specified by:
    
    byte2IntEntrySet in interface Byte2IntMap
    
    Specified by:
    
    byte2IntEntrySet in interface Byte2IntOrderedMap
    
    Returns:
    
    a EntrySet of the collection
  - keySet
```
public ByteOrderedSet keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Byte,java.lang.Integer>
    
    Specified by:
    
    keySet in interface Byte2IntMap
    
    Specified by:
    
    keySet in interface Byte2IntOrderedMap
    
    Overrides:
    
    keySet in class AbstractByte2IntMap
  - values
```
public IntCollection values()
```
    Specified by:
    
    values in interface java.util.Map<java.lang.Byte,java.lang.Integer>
    
    Specified by:
    
    values in interface Byte2IntMap
    
    Overrides:
    
    values in class AbstractByte2IntMap
  - copy
```
public ImmutableByte2IntOpenHashMap copy()
```
    Description copied from interface: Byte2IntMap
    
    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 Byte2IntMap
    
    Specified by:
    
    copy in interface Byte2IntOrderedMap
    
    Overrides:
    
    copy in class AbstractByte2IntMap
    
    Returns:
    
    a Shallow Copy of the Map
  - forEach
```
public void forEach(ByteIntConsumer action)
```
    Description copied from interface: Byte2IntMap
    
    Type Specific forEach method to reduce boxing/unboxing
    
    Specified by:
    
    forEach in interface Byte2IntMap
    
    Overrides:
    
    forEach in class AbstractByte2IntMap
    
    Parameters:
    
    action - processor of the values that are iterator over
  - replace
```
public boolean replace(byte key,
                       int oldValue,
                       int newValue)
```
    Description copied from interface: Byte2IntMap
    
    A Type Specific replace method to replace an existing value
    
    Specified by:
    
    replace in interface Byte2IntMap
    
    Overrides:
    
    replace in class AbstractByte2IntMap
    
    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 int replace(byte key,
                   int value)
```
    Description copied from interface: Byte2IntMap
    
    A Type Specific replace method to reduce boxing/unboxing replace an existing value
    
    Specified by:
    
    replace in interface Byte2IntMap
    
    Overrides:
    
    replace in class AbstractByte2IntMap
    
    Parameters:
    
    key - the element that should be searched for
    
    value - the value to replace with.
    
    Returns:
    
    the present value or default return value
  - computeInt
```
public int computeInt(byte key,
                      ByteIntUnaryOperator mappingFunction)
```
    Description copied from interface: Byte2IntMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeInt in interface Byte2IntMap
    
    Overrides:
    
    computeInt in class AbstractByte2IntMap
    
    Parameters:
    
    key - the key that should be computed
    
    mappingFunction - the operator that should generate the value
    
    Returns:
    
    the result of the computation
  - computeIntIfAbsent
```
public int computeIntIfAbsent(byte key,
                              Byte2IntFunction mappingFunction)
```
    Description copied from interface: Byte2IntMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeIntIfAbsent in interface Byte2IntMap
    
    Overrides:
    
    computeIntIfAbsent in class AbstractByte2IntMap
    
    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
  - supplyIntIfAbsent
```
public int supplyIntIfAbsent(byte key,
                             IntSupplier valueProvider)
```
    Description copied from interface: Byte2IntMap
    
    A Supplier based computeIfAbsent function to fill the most used usecase of this function
    
    Specified by:
    
    supplyIntIfAbsent in interface Byte2IntMap
    
    Overrides:
    
    supplyIntIfAbsent in class AbstractByte2IntMap
    
    Parameters:
    
    key - the key that should be computed
    
    valueProvider - the value if not present
    
    Returns:
    
    the result of the computed value or present value
  - computeIntIfPresent
```
public int computeIntIfPresent(byte key,
                               ByteIntUnaryOperator mappingFunction)
```
    Description copied from interface: Byte2IntMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeIntIfPresent in interface Byte2IntMap
    
    Overrides:
    
    computeIntIfPresent in class AbstractByte2IntMap
    
    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
  - mergeInt
```
public int mergeInt(byte key,
                    int value,
                    IntIntUnaryOperator mappingFunction)
```
    Description copied from interface: Byte2IntMap
    
    A Type Specific merge method to reduce boxing/unboxing
    
    Specified by:
    
    mergeInt in interface Byte2IntMap
    
    Overrides:
    
    mergeInt in class AbstractByte2IntMap
    
    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
  - mergeAllInt
```
public void mergeAllInt(Byte2IntMap m,
                        IntIntUnaryOperator mappingFunction)
```
    Description copied from interface: Byte2IntMap
    
    A Bulk method for merging Maps.
    
    Specified by:
    
    mergeAllInt in interface Byte2IntMap
    
    Overrides:
    
    mergeAllInt in class AbstractByte2IntMap
    
    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.Byte,java.lang.Integer>
    
    Overrides:
    
    size in class java.util.AbstractMap<java.lang.Byte,java.lang.Integer>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<java.lang.Byte,java.lang.Integer>
    
    Overrides:
    
    clear in class java.util.AbstractMap<java.lang.Byte,java.lang.Integer>

Class ImmutableByte2IntOpenHashMap

Nested Class Summary

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

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

Nested classes/interfaces inherited from interface speiger.src.collections.bytes.maps.interfaces.Byte2IntOrderedMap

Nested classes/interfaces inherited from interface speiger.src.collections.bytes.maps.interfaces.Byte2IntMap

Constructor Summary

Method Summary

Methods inherited from class speiger.src.collections.bytes.maps.abstracts.AbstractByte2IntMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.bytes.maps.interfaces.Byte2IntOrderedMap

Methods inherited from interface speiger.src.collections.bytes.maps.interfaces.Byte2IntMap

Methods inherited from interface java.util.Map

Constructor Detail

ImmutableByte2IntOpenHashMap

ImmutableByte2IntOpenHashMap

ImmutableByte2IntOpenHashMap

ImmutableByte2IntOpenHashMap

ImmutableByte2IntOpenHashMap

ImmutableByte2IntOpenHashMap

ImmutableByte2IntOpenHashMap

ImmutableByte2IntOpenHashMap

Method Detail

put

putIfAbsent

addTo

subFrom

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

containsKey

containsKey

containsValue

containsValue

remove

removeOrDefault

remove

remove

remove

get

get

getOrDefault

firstByteKey

pollFirstByteKey

lastByteKey

pollLastByteKey

firstIntValue

lastIntValue

byte2IntEntrySet

keySet

values

copy

forEach

replace

replace

computeInt

computeIntIfAbsent

supplyIntIfAbsent

computeIntIfPresent

mergeInt

mergeAllInt

size

clear