Float2DoubleMaps.UnmodifyableMap (Primitive-Collections 0.7.0 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Float,java.lang.Double>
- - speiger.src.collections.floats.maps.abstracts.AbstractFloat2DoubleMap
  - - speiger.src.collections.floats.utils.maps.Float2DoubleMaps.UnmodifyableMap

All Implemented Interfaces:

java.util.Map<java.lang.Float,java.lang.Double>, Float2DoubleFunction, Float2DoubleMap

Direct Known Subclasses:

Float2DoubleMaps.UnmodifyableOrderedMap, Float2DoubleMaps.UnmodifyableSortedMap

Enclosing class:

Float2DoubleMaps
```
public static class Float2DoubleMaps.UnmodifyableMap
extends AbstractFloat2DoubleMap
implements Float2DoubleMap
```
The Unmodifyable Map implementation that is sued for the unmodifyableMap function

Nested Class Summary
- Nested classes/interfaces inherited from class speiger.src.collections.floats.maps.abstracts.AbstractFloat2DoubleMap
  AbstractFloat2DoubleMap.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.floats.maps.interfaces.Float2DoubleMap
  Float2DoubleMap.BuilderCache, Float2DoubleMap.Entry, Float2DoubleMap.FastEntrySet, Float2DoubleMap.MapBuilder

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`addTo(float key, double value)` A Helper method to add a primitives together.
`void`	`clear()`
`double`	`computeDouble(float key, FloatDoubleUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`double`	`computeDoubleIfAbsent(float key, Float2DoubleFunction mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`double`	`computeDoubleIfPresent(float key, FloatDoubleUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`Float2DoubleMap`	`copy()` A Function that does a shallow clone of the Map itself.
`ObjectSet<Float2DoubleMap.Entry>`	`float2DoubleEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`double`	`get(float key)` A Type Specific get method to reduce boxing/unboxing
`double`	`getOrDefault(float key, double defaultValue)` A Type Specific getOrDefault method to reduce boxing/unboxing
`FloatSet`	`keySet()`
`void`	`mergeAllDouble(Float2DoubleMap m, DoubleDoubleUnaryOperator mappingFunction)` A Bulk method for merging Maps.
`double`	`mergeDouble(float key, double value, DoubleDoubleUnaryOperator mappingFunction)` A Type Specific merge method to reduce boxing/unboxing
`double`	`put(float key, double value)` Type Specific method to reduce boxing/unboxing of values
`double`	`putIfAbsent(float key, double value)` Type Specific method to reduce boxing/unboxing of values
`double`	`remove(float key)` Type Specific remove function to reduce boxing/unboxing
`boolean`	`remove(float key, double value)` Type Specific remove function to reduce boxing/unboxing
`double`	`removeOrDefault(float key, double defaultValue)` Type-Specific Remove function with a default return value if wanted.
`void`	`replaceDoubles(Float2DoubleMap m)` Type-Specific bulk replace method.
`void`	`replaceDoubles(FloatDoubleUnaryOperator mappingFunction)` A Type Specific mass replace method to reduce boxing/unboxing
`double`	`subFrom(float key, double value)` A Helper method to subtract from primitive from each other.
`double`	`supplyDoubleIfAbsent(float key, DoubleSupplier valueProvider)` A Supplier based computeIfAbsent function to fill the most used usecase of this function
`DoubleCollection`	`values()`

Methods inherited from class speiger.src.collections.floats.maps.abstracts.AbstractFloat2DoubleMap
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.floats.maps.interfaces.Float2DoubleMap
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 double put(float key,
                  double value)
```
    Description copied from interface: Float2DoubleMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    put in interface Float2DoubleMap
    
    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 double putIfAbsent(float key,
                          double value)
```
    Description copied from interface: Float2DoubleMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    putIfAbsent in interface Float2DoubleMap
    
    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 double addTo(float key,
                    double value)
```
    Description copied from interface: Float2DoubleMap
    
    A Helper method to add a primitives together. If key is not present then this functions as a put.
    
    Specified by:
    
    addTo in interface Float2DoubleMap
    
    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 double subFrom(float key,
                      double value)
```
    Description copied from interface: Float2DoubleMap
    
    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 Float2DoubleMap.getDefaultReturnValue() If the fence is reached the element will be automaticall removed
    
    Specified by:
    
    subFrom in interface Float2DoubleMap
    
    Parameters:
    
    key - that should be subtract from
    
    value - that should be subtract
    
    Returns:
    
    the last present or default return value
  - remove
```
public double remove(float key)
```
    Description copied from interface: Float2DoubleMap
    
    Type Specific remove function to reduce boxing/unboxing
    
    Specified by:
    
    remove in interface Float2DoubleMap
    
    Parameters:
    
    key - the element that should be removed
    
    Returns:
    
    the value that was removed or default return value
  - removeOrDefault
```
public double removeOrDefault(float key,
                              double defaultValue)
```
    Description copied from interface: Float2DoubleMap
    
    Type-Specific Remove function with a default return value if wanted.
    
    Specified by:
    
    removeOrDefault in interface Float2DoubleMap
    
    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(float key,
                      double value)
```
    Description copied from interface: Float2DoubleMap
    
    Type Specific remove function to reduce boxing/unboxing
    
    Specified by:
    
    remove in interface Float2DoubleMap
    
    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 double get(float key)
```
    Description copied from interface: Float2DoubleMap
    
    A Type Specific get method to reduce boxing/unboxing
    
    Specified by:
    
    get in interface Float2DoubleFunction
    
    Specified by:
    
    get in interface Float2DoubleMap
    
    Parameters:
    
    key - the key that is searched for
    
    Returns:
    
    the searched value or default return value
  - getOrDefault
```
public double getOrDefault(float key,
                           double defaultValue)
```
    Description copied from interface: Float2DoubleMap
    
    A Type Specific getOrDefault method to reduce boxing/unboxing
    
    Specified by:
    
    getOrDefault in interface Float2DoubleMap
    
    Overrides:
    
    getOrDefault in class AbstractFloat2DoubleMap
    
    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
  - computeDouble
```
public double computeDouble(float key,
                            FloatDoubleUnaryOperator mappingFunction)
```
    Description copied from interface: Float2DoubleMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeDouble in interface Float2DoubleMap
    
    Overrides:
    
    computeDouble in class AbstractFloat2DoubleMap
    
    Parameters:
    
    key - the key that should be computed
    
    mappingFunction - the operator that should generate the value
    
    Returns:
    
    the result of the computation
  - computeDoubleIfAbsent
```
public double computeDoubleIfAbsent(float key,
                                    Float2DoubleFunction mappingFunction)
```
    Description copied from interface: Float2DoubleMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeDoubleIfAbsent in interface Float2DoubleMap
    
    Overrides:
    
    computeDoubleIfAbsent in class AbstractFloat2DoubleMap
    
    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
  - computeDoubleIfPresent
```
public double computeDoubleIfPresent(float key,
                                     FloatDoubleUnaryOperator mappingFunction)
```
    Description copied from interface: Float2DoubleMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeDoubleIfPresent in interface Float2DoubleMap
    
    Overrides:
    
    computeDoubleIfPresent in class AbstractFloat2DoubleMap
    
    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
  - supplyDoubleIfAbsent
```
public double supplyDoubleIfAbsent(float key,
                                   DoubleSupplier valueProvider)
```
    Description copied from interface: Float2DoubleMap
    
    A Supplier based computeIfAbsent function to fill the most used usecase of this function
    
    Specified by:
    
    supplyDoubleIfAbsent in interface Float2DoubleMap
    
    Overrides:
    
    supplyDoubleIfAbsent in class AbstractFloat2DoubleMap
    
    Parameters:
    
    key - the key that should be computed
    
    valueProvider - the value if not present
    
    Returns:
    
    the result of the computed value or present value
  - mergeDouble
```
public double mergeDouble(float key,
                          double value,
                          DoubleDoubleUnaryOperator mappingFunction)
```
    Description copied from interface: Float2DoubleMap
    
    A Type Specific merge method to reduce boxing/unboxing
    
    Specified by:
    
    mergeDouble in interface Float2DoubleMap
    
    Overrides:
    
    mergeDouble in class AbstractFloat2DoubleMap
    
    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
  - mergeAllDouble
```
public void mergeAllDouble(Float2DoubleMap m,
                           DoubleDoubleUnaryOperator mappingFunction)
```
    Description copied from interface: Float2DoubleMap
    
    A Bulk method for merging Maps.
    
    Specified by:
    
    mergeAllDouble in interface Float2DoubleMap
    
    Overrides:
    
    mergeAllDouble in class AbstractFloat2DoubleMap
    
    Parameters:
    
    m - the entries that should be bulk added
    
    mappingFunction - the operator that should generate the new Value
  - replaceDoubles
```
public void replaceDoubles(FloatDoubleUnaryOperator mappingFunction)
```
    Description copied from interface: Float2DoubleMap
    
    A Type Specific mass replace method to reduce boxing/unboxing
    
    Specified by:
    
    replaceDoubles in interface Float2DoubleMap
    
    Overrides:
    
    replaceDoubles in class AbstractFloat2DoubleMap
    
    Parameters:
    
    mappingFunction - operation to replace all values
  - replaceDoubles
```
public void replaceDoubles(Float2DoubleMap m)
```
    Description copied from interface: Float2DoubleMap
    
    Type-Specific bulk replace method. Could be seen as putAllIfPresent
    
    Specified by:
    
    replaceDoubles in interface Float2DoubleMap
    
    Overrides:
    
    replaceDoubles in class AbstractFloat2DoubleMap
    
    Parameters:
    
    m - elements that should be replaced.
  - copy
```
public Float2DoubleMap copy()
```
    Description copied from interface: Float2DoubleMap
    
    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 Float2DoubleMap
    
    Overrides:
    
    copy in class AbstractFloat2DoubleMap
    
    Returns:
    
    a Shallow Copy of the Map
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<java.lang.Float,java.lang.Double>
    
    Overrides:
    
    clear in class java.util.AbstractMap<java.lang.Float,java.lang.Double>
  - keySet
```
public FloatSet keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Float,java.lang.Double>
    
    Specified by:
    
    keySet in interface Float2DoubleMap
    
    Overrides:
    
    keySet in class AbstractFloat2DoubleMap
  - values
```
public DoubleCollection values()
```
    Specified by:
    
    values in interface java.util.Map<java.lang.Float,java.lang.Double>
    
    Specified by:
    
    values in interface Float2DoubleMap
    
    Overrides:
    
    values in class AbstractFloat2DoubleMap
  - float2DoubleEntrySet
```
public ObjectSet<Float2DoubleMap.Entry> float2DoubleEntrySet()
```
    Description copied from interface: Float2DoubleMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Specified by:
    
    float2DoubleEntrySet in interface Float2DoubleMap
    
    Returns:
    
    a EntrySet of the collection

Class Float2DoubleMaps.UnmodifyableMap

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.floats.maps.abstracts.AbstractFloat2DoubleMap

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

Nested classes/interfaces inherited from interface speiger.src.collections.floats.maps.interfaces.Float2DoubleMap

Method Summary

Methods inherited from class speiger.src.collections.floats.maps.abstracts.AbstractFloat2DoubleMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.floats.maps.interfaces.Float2DoubleMap

Methods inherited from interface java.util.Map

Method Detail

put

putIfAbsent

addTo

subFrom

remove

removeOrDefault

remove

get

getOrDefault

computeDouble

computeDoubleIfAbsent

computeDoubleIfPresent

supplyDoubleIfAbsent

mergeDouble

mergeAllDouble

replaceDoubles

replaceDoubles

copy

clear

keySet

values

float2DoubleEntrySet