Byte2FloatMaps.UnmodifyableMap (Primitive-Collections 0.2.0 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Byte,java.lang.Float>
- - speiger.src.collections.bytes.maps.abstracts.AbstractByte2FloatMap
  - - speiger.src.collections.bytes.utils.maps.Byte2FloatMaps.UnmodifyableMap

All Implemented Interfaces:

java.util.Map<java.lang.Byte,java.lang.Float>, Byte2FloatFunction, Byte2FloatMap

Direct Known Subclasses:

Byte2FloatMaps.UnmodifyableSortedMap

Enclosing class:

Byte2FloatMaps
```
public static class Byte2FloatMaps.UnmodifyableMap
extends AbstractByte2FloatMap
implements Byte2FloatMap
```
The Unmodifyable Map implementation that is sued for the unmodifyableMap function

Nested Class Summary
- Nested classes/interfaces inherited from class speiger.src.collections.bytes.maps.abstracts.AbstractByte2FloatMap
  AbstractByte2FloatMap.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.Byte2FloatMap
  Byte2FloatMap.Entry, Byte2FloatMap.FastEntrySet

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`float`	`addTo(byte key, float value)` A Helper method to add a primitives together.
`ObjectSet<Byte2FloatMap.Entry>`	`byte2FloatEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`float`	`getFloat(byte key)` A Type Specific get method to reduce boxing/unboxing
`float`	`getOrDefault(byte key, float defaultValue)` A Type Specific getOrDefault method to reduce boxing/unboxing
`ByteSet`	`keySet()`
`float`	`put(byte key, float value)` Type Specific method to reduce boxing/unboxing of values
`float`	`putIfAbsent(byte key, float value)` Type Specific method to reduce boxing/unboxing of values
`float`	`remByte(byte key)` Type Specific remove function to reduce boxing/unboxing
`float`	`remByteOrDefault(byte key, float defaultValue)` Type-Specific Remove function with a default return value if wanted.
`boolean`	`remove(byte key, float value)` Type Specific remove function to reduce boxing/unboxing
`FloatCollection`	`values()`

Methods inherited from class speiger.src.collections.bytes.maps.abstracts.AbstractByte2FloatMap
addToAll, computeFloat, computeFloatIfAbsent, computeFloatIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, mergeAllFloat, mergeFloat, putAll, putAll, putAll, putAllIfAbsent, replace, replace, replaceFloats, replaceFloats, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, put, remove, size, toString

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

Methods inherited from interface speiger.src.collections.bytes.maps.interfaces.Byte2FloatMap
addToAll, compute, computeFloat, computeFloatIfAbsent, computeFloatIfPresent, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, getDefaultReturnValue, getOrDefault, merge, mergeAllFloat, mergeFloat, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, remove, remove, replace, replace, replace, replace, replaceAll, replaceFloats, replaceFloats, setDefaultReturnValue

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

- Method Detail
  - put
```
public float put(byte key,
                 float value)
```
    Description copied from interface: Byte2FloatMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    put in interface Byte2FloatMap
    
    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 float putIfAbsent(byte key,
                         float value)
```
    Description copied from interface: Byte2FloatMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    putIfAbsent in interface Byte2FloatMap
    
    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 float addTo(byte key,
                   float value)
```
    Description copied from interface: Byte2FloatMap
    
    A Helper method to add a primitives together. If key is not present then this functions as a put.
    
    Specified by:
    
    addTo in interface Byte2FloatMap
    
    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.
  - remByte
```
public float remByte(byte key)
```
    Description copied from interface: Byte2FloatMap
    
    Type Specific remove function to reduce boxing/unboxing
    
    Specified by:
    
    remByte in interface Byte2FloatMap
    
    Parameters:
    
    key - the element that should be removed
    
    Returns:
    
    the value that was removed or default return value
  - remByteOrDefault
```
public float remByteOrDefault(byte key,
                              float defaultValue)
```
    Description copied from interface: Byte2FloatMap
    
    Type-Specific Remove function with a default return value if wanted.
    
    Specified by:
    
    remByteOrDefault in interface Byte2FloatMap
    
    Parameters:
    
    key - the element that should be removed
    
    defaultValue - the value that should be returned if the entry doesn't exist
    
    Returns:
    
    the value that was removed or default value
    
    See Also:
    
    Map.remove(Object, Object)
  - remove
```
public boolean remove(byte key,
                      float value)
```
    Description copied from interface: Byte2FloatMap
    
    Type Specific remove function to reduce boxing/unboxing
    
    Specified by:
    
    remove in interface Byte2FloatMap
    
    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)
  - getFloat
```
public float getFloat(byte key)
```
    Description copied from interface: Byte2FloatMap
    
    A Type Specific get method to reduce boxing/unboxing
    
    Specified by:
    
    getFloat in interface Byte2FloatFunction
    
    Specified by:
    
    getFloat in interface Byte2FloatMap
    
    Parameters:
    
    key - the key that is searched for
    
    Returns:
    
    the searched value or default return value
  - getOrDefault
```
public float getOrDefault(byte key,
                          float defaultValue)
```
    Description copied from interface: Byte2FloatMap
    
    A Type Specific getOrDefault method to reduce boxing/unboxing
    
    Specified by:
    
    getOrDefault in interface Byte2FloatMap
    
    Overrides:
    
    getOrDefault in class AbstractByte2FloatMap
    
    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
  - keySet
```
public ByteSet keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Byte,java.lang.Float>
    
    Specified by:
    
    keySet in interface Byte2FloatMap
    
    Overrides:
    
    keySet in class AbstractByte2FloatMap
  - values
```
public FloatCollection values()
```
    Specified by:
    
    values in interface java.util.Map<java.lang.Byte,java.lang.Float>
    
    Specified by:
    
    values in interface Byte2FloatMap
    
    Overrides:
    
    values in class AbstractByte2FloatMap
  - byte2FloatEntrySet
```
public ObjectSet<Byte2FloatMap.Entry> byte2FloatEntrySet()
```
    Description copied from interface: Byte2FloatMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Specified by:
    
    byte2FloatEntrySet in interface Byte2FloatMap
    
    Returns:
    
    a EntrySet of the collection

Class Byte2FloatMaps.UnmodifyableMap

Nested Class Summary

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

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

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

Method Summary

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

Method Detail

put

putIfAbsent

addTo

remByte

remByteOrDefault

remove

getFloat

getOrDefault

keySet

values

byte2FloatEntrySet