AbstractObject2DoubleMap (Primitive-Collections 0.7.0 API)

java.lang.Object
- java.util.AbstractMap<T,java.lang.Double>
- - speiger.src.collections.objects.maps.abstracts.AbstractObject2DoubleMap<T>

Type Parameters:

T - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.ToDoubleFunction<T>, java.util.Map<T,java.lang.Double>, Object2DoubleFunction<T>, Object2DoubleMap<T>

Direct Known Subclasses:

Enum2DoubleMap, ImmutableObject2DoubleOpenHashMap, Object2DoubleArrayMap, Object2DoubleAVLTreeMap, Object2DoubleConcurrentOpenHashMap, Object2DoubleMaps.EmptyMap, Object2DoubleMaps.SingletonMap, Object2DoubleMaps.SynchronizedMap, Object2DoubleMaps.UnmodifyableMap, Object2DoubleOpenCustomHashMap, Object2DoubleOpenHashMap, Object2DoubleRBTreeMap
```
public abstract class AbstractObject2DoubleMap<T>
extends java.util.AbstractMap<T,java.lang.Double>
implements Object2DoubleMap<T>
```
A Base Implementation of a Type Specific Map to reduce boxing/unboxing

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AbstractObject2DoubleMap.BasicEntry<T>
A Simple Type Specific Entry class to reduce boxing/unboxing
- 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.objects.maps.interfaces.Object2DoubleMap
  Object2DoubleMap.BuilderCache<T>, Object2DoubleMap.Entry<T>, Object2DoubleMap.FastEntrySet<T>, Object2DoubleMap.MapBuilder

Nested Classes
Modifier and Type	Class and Description
`static class`	`AbstractObject2DoubleMap.BasicEntry<T>` A Simple Type Specific Entry class to reduce boxing/unboxing

Constructor Summary

Constructors
Constructor and Description

AbstractObject2DoubleMap()

Constructors
Constructor and Description
`AbstractObject2DoubleMap()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addToAll(Object2DoubleMap<T> m)` A Helper method to bulk add primitives together.
`double`	`computeDouble(T key, ObjectDoubleUnaryOperator<T> mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`double`	`computeDoubleIfAbsent(T key, Object2DoubleFunction<T> mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`double`	`computeDoubleIfPresent(T key, ObjectDoubleUnaryOperator<T> mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(double value)` Type Specific method to reduce boxing/unboxing of values
`Object2DoubleMap<T>`	`copy()` A Function that does a shallow clone of the Map itself.
`ObjectSet<java.util.Map.Entry<T,java.lang.Double>>`	`entrySet()`
`boolean`	`equals(java.lang.Object o)`
`void`	`forEach(ObjectDoubleConsumer<T> action)` Type Specific forEach method to reduce boxing/unboxing
`java.lang.Double`	`get(java.lang.Object key)`
`double`	`getDefaultReturnValue()` Method to see what the default return value is.
`java.lang.Double`	`getOrDefault(java.lang.Object key, java.lang.Double defaultValue)`
`int`	`hashCode()`
`ObjectSet<T>`	`keySet()`
`void`	`mergeAllDouble(Object2DoubleMap<T> m, DoubleDoubleUnaryOperator mappingFunction)` A Bulk method for merging Maps.
`double`	`mergeDouble(T key, double value, DoubleDoubleUnaryOperator mappingFunction)` A Type Specific merge method to reduce boxing/unboxing
`java.lang.Double`	`put(T key, java.lang.Double value)` Deprecated.
`void`	`putAll(java.util.Map<? extends T,? extends java.lang.Double> m)`
`void`	`putAll(Object2DoubleMap<T> m)` Type Specific function for the bull putting of values
`void`	`putAll(T[] keys, double[] values, int offset, int size)` Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
`void`	`putAll(T[] keys, java.lang.Double[] values, int offset, int size)` Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances
`void`	`putAllIfAbsent(Object2DoubleMap<T> m)` Type-Specific bulk put method put elements into the map if not present.
`java.lang.Double`	`remove(java.lang.Object key)`
`double`	`replace(T key, double value)` A Type Specific replace method to reduce boxing/unboxing replace an existing value
`boolean`	`replace(T key, double oldValue, double newValue)` A Type Specific replace method to replace an existing value
`void`	`replaceDoubles(Object2DoubleMap<T> m)` Type-Specific bulk replace method.
`void`	`replaceDoubles(ObjectDoubleUnaryOperator<T> mappingFunction)` A Type Specific mass replace method to reduce boxing/unboxing
`AbstractObject2DoubleMap<T>`	`setDefaultReturnValue(double v)` Method to define the default return value if a requested key isn't present
`double`	`supplyDoubleIfAbsent(T key, DoubleSupplier valueProvider)` A Supplier based computeIfAbsent function to fill the most used usecase of this function
`DoubleCollection`	`values()`

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

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

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2DoubleMap
addTo, builder, compute, computeIfAbsent, computeIfPresent, containsValue, forEach, getDouble, getOrDefault, merge, object2DoubleEntrySet, put, putAll, putAll, putIfAbsent, putIfAbsent, rem, remOrDefault, remove, remove, replace, replace, replaceAll, subFrom, synchronize, synchronize, unmodifiable

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

Methods inherited from interface speiger.src.collections.objects.functions.function.Object2DoubleFunction
applyAsDouble

- Constructor Detail
  - AbstractObject2DoubleMap
```
public AbstractObject2DoubleMap()
```
- Method Detail
  - getDefaultReturnValue
```
public double getDefaultReturnValue()
```
    Description copied from interface: Object2DoubleMap
    
    Method to see what the default return value is.
    
    Specified by:
    
    getDefaultReturnValue in interface Object2DoubleMap<T>
    
    Returns:
    
    default return value
  - setDefaultReturnValue
```
public AbstractObject2DoubleMap<T> setDefaultReturnValue(double v)
```
    Description copied from interface: Object2DoubleMap
    
    Method to define the default return value if a requested key isn't present
    
    Specified by:
    
    setDefaultReturnValue in interface Object2DoubleMap<T>
    
    Parameters:
    
    v - value that should be the default return value
    
    Returns:
    
    itself
  - copy
```
public Object2DoubleMap<T> copy()
```
    Description copied from interface: Object2DoubleMap
    
    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 Object2DoubleMap<T>
    
    Returns:
    
    a Shallow Copy of the Map
  - put
```
@Deprecated
public java.lang.Double put(T key,
                                         java.lang.Double value)
```
    Deprecated.
    
    Specified by:
    
    put in interface java.util.Map<T,java.lang.Double>
    
    Specified by:
    
    put in interface Object2DoubleMap<T>
    
    Overrides:
    
    put in class java.util.AbstractMap<T,java.lang.Double>
  - addToAll
```
public void addToAll(Object2DoubleMap<T> m)
```
    Description copied from interface: Object2DoubleMap
    
    A Helper method to bulk add primitives together.
    
    Specified by:
    
    addToAll in interface Object2DoubleMap<T>
    
    Parameters:
    
    m - the values that should be added/inserted
  - putAll
```
public void putAll(Object2DoubleMap<T> m)
```
    Description copied from interface: Object2DoubleMap
    
    Type Specific function for the bull putting of values
    
    Specified by:
    
    putAll in interface Object2DoubleMap<T>
    
    Parameters:
    
    m - the elements that should be inserted
  - putAll
```
public void putAll(java.util.Map<? extends T,? extends java.lang.Double> m)
```
    Specified by:
    
    putAll in interface java.util.Map<T,java.lang.Double>
    
    Overrides:
    
    putAll in class java.util.AbstractMap<T,java.lang.Double>
  - putAll
```
public void putAll(T[] keys,
                   double[] values,
                   int offset,
                   int size)
```
    Description copied from interface: Object2DoubleMap
    
    Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
    
    Specified by:
    
    putAll in interface Object2DoubleMap<T>
    
    Parameters:
    
    keys - the keys that should be added
    
    values - the values that should be added
    
    offset - where the to start in the array
    
    size - how many elements should be added
    
    See Also:
    
    Map.putAll(Map)
  - putAll
```
public void putAll(T[] keys,
                   java.lang.Double[] values,
                   int offset,
                   int size)
```
    Description copied from interface: Object2DoubleMap
    
    Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances
    
    Specified by:
    
    putAll in interface Object2DoubleMap<T>
    
    Parameters:
    
    keys - the keys that should be added
    
    values - the values that should be added
    
    offset - where the to start in the array
    
    size - how many elements should be added
    
    See Also:
    
    Map.putAll(Map)
  - putAllIfAbsent
```
public void putAllIfAbsent(Object2DoubleMap<T> m)
```
    Description copied from interface: Object2DoubleMap
    
    Type-Specific bulk put method put elements into the map if not present.
    
    Specified by:
    
    putAllIfAbsent in interface Object2DoubleMap<T>
    
    Parameters:
    
    m - elements that should be added if not present.
  - containsKey
```
public boolean containsKey(java.lang.Object key)
```
    Specified by:
    
    containsKey in interface java.util.Map<T,java.lang.Double>
    
    Overrides:
    
    containsKey in class java.util.AbstractMap<T,java.lang.Double>
  - containsValue
```
public boolean containsValue(double value)
```
    Description copied from interface: Object2DoubleMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    containsValue in interface Object2DoubleMap<T>
    
    Parameters:
    
    value - element that is searched for
    
    Returns:
    
    if the value is present
  - replace
```
public boolean replace(T key,
                       double oldValue,
                       double newValue)
```
    Description copied from interface: Object2DoubleMap
    
    A Type Specific replace method to replace an existing value
    
    Specified by:
    
    replace in interface Object2DoubleMap<T>
    
    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 double replace(T key,
                      double value)
```
    Description copied from interface: Object2DoubleMap
    
    A Type Specific replace method to reduce boxing/unboxing replace an existing value
    
    Specified by:
    
    replace in interface Object2DoubleMap<T>
    
    Parameters:
    
    key - the element that should be searched for
    
    value - the value to replace with.
    
    Returns:
    
    the present value or default return value
  - replaceDoubles
```
public void replaceDoubles(Object2DoubleMap<T> m)
```
    Description copied from interface: Object2DoubleMap
    
    Type-Specific bulk replace method. Could be seen as putAllIfPresent
    
    Specified by:
    
    replaceDoubles in interface Object2DoubleMap<T>
    
    Parameters:
    
    m - elements that should be replaced.
  - replaceDoubles
```
public void replaceDoubles(ObjectDoubleUnaryOperator<T> mappingFunction)
```
    Description copied from interface: Object2DoubleMap
    
    A Type Specific mass replace method to reduce boxing/unboxing
    
    Specified by:
    
    replaceDoubles in interface Object2DoubleMap<T>
    
    Parameters:
    
    mappingFunction - operation to replace all values
  - computeDouble
```
public double computeDouble(T key,
                            ObjectDoubleUnaryOperator<T> mappingFunction)
```
    Description copied from interface: Object2DoubleMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeDouble in interface Object2DoubleMap<T>
    
    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(T key,
                                    Object2DoubleFunction<T> mappingFunction)
```
    Description copied from interface: Object2DoubleMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeDoubleIfAbsent in interface Object2DoubleMap<T>
    
    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
  - supplyDoubleIfAbsent
```
public double supplyDoubleIfAbsent(T key,
                                   DoubleSupplier valueProvider)
```
    Description copied from interface: Object2DoubleMap
    
    A Supplier based computeIfAbsent function to fill the most used usecase of this function
    
    Specified by:
    
    supplyDoubleIfAbsent in interface Object2DoubleMap<T>
    
    Parameters:
    
    key - the key that should be computed
    
    valueProvider - the value if not present
    
    Returns:
    
    the result of the computed value or present value
  - computeDoubleIfPresent
```
public double computeDoubleIfPresent(T key,
                                     ObjectDoubleUnaryOperator<T> mappingFunction)
```
    Description copied from interface: Object2DoubleMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeDoubleIfPresent in interface Object2DoubleMap<T>
    
    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
  - mergeDouble
```
public double mergeDouble(T key,
                          double value,
                          DoubleDoubleUnaryOperator mappingFunction)
```
    Description copied from interface: Object2DoubleMap
    
    A Type Specific merge method to reduce boxing/unboxing
    
    Specified by:
    
    mergeDouble in interface Object2DoubleMap<T>
    
    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(Object2DoubleMap<T> m,
                           DoubleDoubleUnaryOperator mappingFunction)
```
    Description copied from interface: Object2DoubleMap
    
    A Bulk method for merging Maps.
    
    Specified by:
    
    mergeAllDouble in interface Object2DoubleMap<T>
    
    Parameters:
    
    m - the entries that should be bulk added
    
    mappingFunction - the operator that should generate the new Value
  - get
```
public java.lang.Double get(java.lang.Object key)
```
    Specified by:
    
    get in interface java.util.Map<T,java.lang.Double>
    
    Specified by:
    
    get in interface Object2DoubleMap<T>
    
    Overrides:
    
    get in class java.util.AbstractMap<T,java.lang.Double>
  - getOrDefault
```
public java.lang.Double getOrDefault(java.lang.Object key,
                                     java.lang.Double defaultValue)
```
    Specified by:
    
    getOrDefault in interface java.util.Map<T,java.lang.Double>
    
    Specified by:
    
    getOrDefault in interface Object2DoubleMap<T>
  - remove
```
public java.lang.Double remove(java.lang.Object key)
```
    Specified by:
    
    remove in interface java.util.Map<T,java.lang.Double>
    
    Specified by:
    
    remove in interface Object2DoubleMap<T>
    
    Overrides:
    
    remove in class java.util.AbstractMap<T,java.lang.Double>
    
    Parameters:
    
    key - the element that should be removed
    
    Returns:
    
    the value that was removed or default return value
    
    See Also:
    
    Map.remove(Object)
  - forEach
```
public void forEach(ObjectDoubleConsumer<T> action)
```
    Description copied from interface: Object2DoubleMap
    
    Type Specific forEach method to reduce boxing/unboxing
    
    Specified by:
    
    forEach in interface Object2DoubleMap<T>
    
    Parameters:
    
    action - processor of the values that are iterator over
  - keySet
```
public ObjectSet<T> keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<T,java.lang.Double>
    
    Specified by:
    
    keySet in interface Object2DoubleMap<T>
    
    Overrides:
    
    keySet in class java.util.AbstractMap<T,java.lang.Double>
  - values
```
public DoubleCollection values()
```
    Specified by:
    
    values in interface java.util.Map<T,java.lang.Double>
    
    Specified by:
    
    values in interface Object2DoubleMap<T>
    
    Overrides:
    
    values in class java.util.AbstractMap<T,java.lang.Double>
  - entrySet
```
public ObjectSet<java.util.Map.Entry<T,java.lang.Double>> entrySet()
```
    Specified by:
    
    entrySet in interface java.util.Map<T,java.lang.Double>
    
    Specified by:
    
    entrySet in interface Object2DoubleMap<T>
    
    Specified by:
    
    entrySet in class java.util.AbstractMap<T,java.lang.Double>
  - equals
```
public boolean equals(java.lang.Object o)
```
    Specified by:
    
    equals in interface java.util.Map<T,java.lang.Double>
    
    Overrides:
    
    equals in class java.util.AbstractMap<T,java.lang.Double>
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface java.util.Map<T,java.lang.Double>
    
    Overrides:
    
    hashCode in class java.util.AbstractMap<T,java.lang.Double>

Class AbstractObject2DoubleMap<T>

Nested Class Summary

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

Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2DoubleMap

Constructor Summary

Method Summary

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2DoubleMap

Methods inherited from interface java.util.Map

Methods inherited from interface speiger.src.collections.objects.functions.function.Object2DoubleFunction

Constructor Detail

AbstractObject2DoubleMap

Method Detail

getDefaultReturnValue

setDefaultReturnValue

copy

put

addToAll

putAll

putAll

putAll

putAll

putAllIfAbsent

containsKey

containsValue

replace

replace

replaceDoubles

replaceDoubles

computeDouble

computeDoubleIfAbsent

supplyDoubleIfAbsent

computeDoubleIfPresent

mergeDouble

mergeAllDouble

get

getOrDefault

remove

forEach

keySet

values

entrySet

equals

hashCode