Object2LongMap (Primitive-Collections 0.7.0 API)

Type Parameters:

T - the type of elements maintained by this Collection

All Superinterfaces:

java.util.Map<T,java.lang.Long>, Object2LongFunction<T>, java.util.function.ToLongFunction<T>

All Known Subinterfaces:

Object2LongConcurrentMap<T>, Object2LongNavigableMap<T>, Object2LongOrderedMap<T>, Object2LongSortedMap<T>

All Known Implementing Classes:

AbstractObject2LongMap, Enum2LongMap, ImmutableObject2LongOpenHashMap, LinkedEnum2LongMap, Object2LongArrayMap, Object2LongAVLTreeMap, Object2LongConcurrentOpenHashMap, Object2LongLinkedOpenCustomHashMap, Object2LongLinkedOpenHashMap, Object2LongMaps.EmptyMap, Object2LongMaps.SingletonMap, Object2LongMaps.SynchronizedMap, Object2LongMaps.SynchronizedNavigableMap, Object2LongMaps.SynchronizedOrderedMap, Object2LongMaps.SynchronizedSortedMap, Object2LongMaps.UnmodifyableMap, Object2LongMaps.UnmodifyableNavigableMap, Object2LongMaps.UnmodifyableOrderedMap, Object2LongMaps.UnmodifyableSortedMap, Object2LongOpenCustomHashMap, Object2LongOpenHashMap, Object2LongRBTreeMap
```
public interface Object2LongMap<T>
extends java.util.Map<T,java.lang.Long>, Object2LongFunction<T>
```
A Type Specific Map that reduces memory overhead due to boxing/unboxing of Primitives and some extra helper functions.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Object2LongMap.BuilderCache<T>` Builder Cache for allowing to buildMaps
`static interface`	`Object2LongMap.Entry<T>` Type Specific Map Entry that reduces boxing/unboxing
`static interface`	`Object2LongMap.FastEntrySet<T>` Fast Entry set that allows for a faster Entry Iterator by recycling the Entry Object and just exchanging 1 internal value
`static class`	`Object2LongMap.MapBuilder` Helper class that reduces the method spam of the Map Class.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`long`	`addTo(T key, long value)` A Helper method to add a primitives together.
`void`	`addToAll(Object2LongMap<T> m)` A Helper method to bulk add primitives together.
`static Object2LongMap.MapBuilder`	`builder()` Helper Class that allows to create Maps without requiring a to type out the entire implementation or know it.
`default java.lang.Long`	`compute(T key, java.util.function.BiFunction<? super T,? super java.lang.Long,? extends java.lang.Long> mappingFunction)`
`default java.lang.Long`	`computeIfAbsent(T key, java.util.function.Function<? super T,? extends java.lang.Long> mappingFunction)`
`default java.lang.Long`	`computeIfPresent(T key, java.util.function.BiFunction<? super T,? super java.lang.Long,? extends java.lang.Long> mappingFunction)`
`long`	`computeLong(T key, ObjectLongUnaryOperator<T> mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`long`	`computeLongIfAbsent(T key, Object2LongFunction<T> mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`long`	`computeLongIfPresent(T key, ObjectLongUnaryOperator<T> mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`boolean`	`containsValue(long value)` Type Specific method to reduce boxing/unboxing of values
`default boolean`	`containsValue(java.lang.Object value)`
`Object2LongMap<T>`	`copy()` A Function that does a shallow clone of the Map itself.
`ObjectSet<java.util.Map.Entry<T,java.lang.Long>>`	`entrySet()`
`default void`	`forEach(java.util.function.BiConsumer<? super T,? super java.lang.Long> action)`
`void`	`forEach(ObjectLongConsumer<T> action)` Type Specific forEach method to reduce boxing/unboxing
`default java.lang.Long`	`get(java.lang.Object key)`
`long`	`getDefaultReturnValue()` Method to see what the default return value is.
`long`	`getLong(T key)` A Type Specific get method to reduce boxing/unboxing
`default java.lang.Long`	`getOrDefault(java.lang.Object key, java.lang.Long defaultValue)`
`long`	`getOrDefault(T key, long defaultValue)` A Type Specific getOrDefault method to reduce boxing/unboxing
`ObjectSet<T>`	`keySet()`
`default java.lang.Long`	`merge(T key, java.lang.Long value, java.util.function.BiFunction<? super java.lang.Long,? super java.lang.Long,? extends java.lang.Long> mappingFunction)`
`void`	`mergeAllLong(Object2LongMap<T> m, LongLongUnaryOperator mappingFunction)` A Bulk method for merging Maps.
`long`	`mergeLong(T key, long value, LongLongUnaryOperator mappingFunction)` A Type Specific merge method to reduce boxing/unboxing
`ObjectSet<Object2LongMap.Entry<T>>`	`object2LongEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`long`	`put(T key, long value)` Type Specific method to reduce boxing/unboxing of values
`default java.lang.Long`	`put(T key, java.lang.Long value)`
`void`	`putAll(Object2LongMap<T> m)` Type Specific function for the bull putting of values
`default void`	`putAll(T[] keys, long[] values)` Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
`default void`	`putAll(T[] keys, java.lang.Long[] values)` Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances
`void`	`putAll(T[] keys, long[] 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.Long[] 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(Object2LongMap<T> m)` Type-Specific bulk put method put elements into the map if not present.
`long`	`putIfAbsent(T key, long value)` Type Specific method to reduce boxing/unboxing of values
`default java.lang.Long`	`putIfAbsent(T key, java.lang.Long value)`
`long`	`rem(T key)` Type Specific remove function to reduce boxing/unboxing
`long`	`remOrDefault(T key, long defaultValue)` Type-Specific Remove function with a default return value if wanted.
`default java.lang.Long`	`remove(java.lang.Object key)`
`default boolean`	`remove(java.lang.Object key, java.lang.Object value)`
`boolean`	`remove(T key, long value)` Type Specific remove function to reduce boxing/unboxing
`long`	`replace(T key, long value)` A Type Specific replace method to reduce boxing/unboxing replace an existing value
`default java.lang.Long`	`replace(T key, java.lang.Long value)`
`boolean`	`replace(T key, long oldValue, long newValue)` A Type Specific replace method to replace an existing value
`default boolean`	`replace(T key, java.lang.Long oldValue, java.lang.Long newValue)`
`default void`	`replaceAll(java.util.function.BiFunction<? super T,? super java.lang.Long,? extends java.lang.Long> mappingFunction)`
`void`	`replaceLongs(Object2LongMap<T> m)` Type-Specific bulk replace method.
`void`	`replaceLongs(ObjectLongUnaryOperator<T> mappingFunction)` A Type Specific mass replace method to reduce boxing/unboxing
`Object2LongMap<T>`	`setDefaultReturnValue(long v)` Method to define the default return value if a requested key isn't present
`long`	`subFrom(T key, long value)` A Helper method to subtract from primitive from each other.
`long`	`supplyLongIfAbsent(T key, LongSupplier valueProvider)` A Supplier based computeIfAbsent function to fill the most used usecase of this function
`default Object2LongMap<T>`	`synchronize()` Creates a Wrapped Map that is Synchronized
`default Object2LongMap<T>`	`synchronize(java.lang.Object mutex)` Creates a Wrapped Map that is Synchronized
`default Object2LongMap<T>`	`unmodifiable()` Creates a Wrapped Map that is unmodifiable
`LongCollection`	`values()`

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

Methods inherited from interface speiger.src.collections.objects.functions.function.Object2LongFunction
applyAsLong

- Method Detail
  - builder
```
static Object2LongMap.MapBuilder builder()
```
    Helper Class that allows to create Maps without requiring a to type out the entire implementation or know it.
    
    Returns:
    
    a MapBuilder
  - getDefaultReturnValue
```
long getDefaultReturnValue()
```
    Method to see what the default return value is.
    
    Returns:
    
    default return value
  - setDefaultReturnValue
```
Object2LongMap<T> setDefaultReturnValue(long v)
```
    Method to define the default return value if a requested key isn't present
    
    Parameters:
    
    v - value that should be the default return value
    
    Returns:
    
    itself
  - copy
```
Object2LongMap<T> copy()
```
    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
    
    Returns:
    
    a Shallow Copy of the Map
    
    Note:
    
    Wrappers and view Maps will not support this feature
  - put
```
long put(T key,
         long value)
```
    Type Specific method to reduce boxing/unboxing of values
    
    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)
  - putAll
```
default void putAll(T[] keys,
                    long[] values)
```
    Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
    
    Parameters:
    
    keys - the keys that should be added
    
    values - the values that should be added
    
    Throws:
    
    java.lang.IllegalStateException - if the arrays are not the same size
    
    See Also:
    
    Map.putAll(Map)
  - putAll
```
void putAll(T[] keys,
            long[] values,
            int offset,
            int size)
```
    Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
    
    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
    
    Throws:
    
    java.lang.IllegalStateException - if the arrays are not within the range
    
    See Also:
    
    Map.putAll(Map)
  - putAll
```
default void putAll(T[] keys,
                    java.lang.Long[] values)
```
    Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances
    
    Parameters:
    
    keys - the keys that should be added
    
    values - the values that should be added
    
    Throws:
    
    java.lang.IllegalStateException - if the arrays are not the same size
    
    See Also:
    
    Map.putAll(Map)
  - putAll
```
void putAll(T[] keys,
            java.lang.Long[] values,
            int offset,
            int size)
```
    Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances
    
    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
    
    Throws:
    
    java.lang.IllegalStateException - if the arrays are not within the range
    
    See Also:
    
    Map.putAll(Map)
  - putIfAbsent
```
long putIfAbsent(T key,
                 long value)
```
    Type Specific method to reduce boxing/unboxing of values
    
    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)
  - putAllIfAbsent
```
void putAllIfAbsent(Object2LongMap<T> m)
```
    Type-Specific bulk put method put elements into the map if not present.
    
    Parameters:
    
    m - elements that should be added if not present.
  - addTo
```
long addTo(T key,
           long value)
```
    A Helper method to add a primitives together. If key is not present then this functions as a put.
    
    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.
  - addToAll
```
void addToAll(Object2LongMap<T> m)
```
    A Helper method to bulk add primitives together.
    
    Parameters:
    
    m - the values that should be added/inserted
  - subFrom
```
long subFrom(T key,
             long value)
```
    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 getDefaultReturnValue() If the fence is reached the element will be automaticall removed
    
    Parameters:
    
    key - that should be subtract from
    
    value - that should be subtract
    
    Returns:
    
    the last present or default return value
  - putAll
```
void putAll(Object2LongMap<T> m)
```
    Type Specific function for the bull putting of values
    
    Parameters:
    
    m - the elements that should be inserted
  - containsValue
```
boolean containsValue(long value)
```
    Type Specific method to reduce boxing/unboxing of values
    
    Parameters:
    
    value - element that is searched for
    
    Returns:
    
    if the value is present
  - containsValue
```
default boolean containsValue(java.lang.Object value)
```
    Specified by:
    
    containsValue in interface java.util.Map<T,java.lang.Long>
    
    Parameters:
    
    value - that is searched for.
    
    Returns:
    
    true if found
    
    See Also:
    
    Map.containsValue(Object)
    
    Note:
    
    in some implementations key does not have to be CLASS_VALUE but just have to support equals with CLASS_VALUE.
  - rem
```
long rem(T key)
```
    Type Specific remove function to reduce boxing/unboxing
    
    Parameters:
    
    key - the element that should be removed
    
    Returns:
    
    the value that was removed or default return value
  - remove
```
default java.lang.Long remove(java.lang.Object key)
```
    Specified by:
    
    remove in interface java.util.Map<T,java.lang.Long>
    
    Parameters:
    
    key - the element that should be removed
    
    Returns:
    
    the value that was removed or default return value
    
    See Also:
    
    Map.remove(Object)
    
    Note:
    
    in some implementations key does not have to be T but just have to support equals with T.
  - remove
```
boolean remove(T key,
               long value)
```
    Type Specific remove function to reduce boxing/unboxing
    
    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
```
default boolean remove(java.lang.Object key,
                       java.lang.Object value)
```
    Specified by:
    
    remove in interface java.util.Map<T,java.lang.Long>
    
    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)
  - remOrDefault
```
long remOrDefault(T key,
                  long defaultValue)
```
    Type-Specific Remove function with a default return value if wanted.
    
    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)
  - replace
```
boolean replace(T key,
                long oldValue,
                long newValue)
```
    A Type Specific replace method to replace an existing value
    
    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
    
    Note:
    
    this fails if the value is not present even if it matches the oldValue
  - replace
```
long replace(T key,
             long value)
```
    A Type Specific replace method to reduce boxing/unboxing replace an existing value
    
    Parameters:
    
    key - the element that should be searched for
    
    value - the value to replace with.
    
    Returns:
    
    the present value or default return value
    
    Note:
    
    this fails if the value is not present
  - replaceLongs
```
void replaceLongs(Object2LongMap<T> m)
```
    Type-Specific bulk replace method. Could be seen as putAllIfPresent
    
    Parameters:
    
    m - elements that should be replaced.
  - replaceLongs
```
void replaceLongs(ObjectLongUnaryOperator<T> mappingFunction)
```
    A Type Specific mass replace method to reduce boxing/unboxing
    
    Parameters:
    
    mappingFunction - operation to replace all values
  - computeLong
```
long computeLong(T key,
                 ObjectLongUnaryOperator<T> mappingFunction)
```
    A Type Specific compute method to reduce boxing/unboxing
    
    Parameters:
    
    key - the key that should be computed
    
    mappingFunction - the operator that should generate the value
    
    Returns:
    
    the result of the computation
  - computeLongIfAbsent
```
long computeLongIfAbsent(T key,
                         Object2LongFunction<T> mappingFunction)
```
    A Type Specific compute method to reduce boxing/unboxing
    
    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
  - supplyLongIfAbsent
```
long supplyLongIfAbsent(T key,
                        LongSupplier valueProvider)
```
    A Supplier based computeIfAbsent function to fill the most used usecase of this function
    
    Parameters:
    
    key - the key that should be computed
    
    valueProvider - the value if not present
    
    Returns:
    
    the result of the computed value or present value
  - computeLongIfPresent
```
long computeLongIfPresent(T key,
                          ObjectLongUnaryOperator<T> mappingFunction)
```
    A Type Specific compute method to reduce boxing/unboxing
    
    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
    
    Note:
    
    if not present then compute is not executed
  - mergeLong
```
long mergeLong(T key,
               long value,
               LongLongUnaryOperator mappingFunction)
```
    A Type Specific merge method to reduce boxing/unboxing
    
    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
    
    Note:
    
    if the result matches the default return value then the key is removed from the map
  - mergeAllLong
```
void mergeAllLong(Object2LongMap<T> m,
                  LongLongUnaryOperator mappingFunction)
```
    A Bulk method for merging Maps.
    
    Parameters:
    
    m - the entries that should be bulk added
    
    mappingFunction - the operator that should generate the new Value
    
    Note:
    
    if the result matches the default return value then the key is removed from the map
  - replace
```
default boolean replace(T key,
                        java.lang.Long oldValue,
                        java.lang.Long newValue)
```
    Specified by:
    
    replace in interface java.util.Map<T,java.lang.Long>
  - replace
```
default java.lang.Long replace(T key,
                               java.lang.Long value)
```
    Specified by:
    
    replace in interface java.util.Map<T,java.lang.Long>
  - getLong
```
long getLong(T key)
```
    A Type Specific get method to reduce boxing/unboxing
    
    Specified by:
    
    getLong in interface Object2LongFunction<T>
    
    Parameters:
    
    key - the key that is searched for
    
    Returns:
    
    the searched value or default return value
  - getOrDefault
```
long getOrDefault(T key,
                  long defaultValue)
```
    A Type Specific getOrDefault method to reduce boxing/unboxing
    
    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
  - get
```
default java.lang.Long get(java.lang.Object key)
```
    Specified by:
    
    get in interface java.util.Map<T,java.lang.Long>
  - getOrDefault
```
default java.lang.Long getOrDefault(java.lang.Object key,
                                    java.lang.Long defaultValue)
```
    Specified by:
    
    getOrDefault in interface java.util.Map<T,java.lang.Long>
  - replaceAll
```
default void replaceAll(java.util.function.BiFunction<? super T,? super java.lang.Long,? extends java.lang.Long> mappingFunction)
```
    Specified by:
    
    replaceAll in interface java.util.Map<T,java.lang.Long>
  - compute
```
default java.lang.Long compute(T key,
                               java.util.function.BiFunction<? super T,? super java.lang.Long,? extends java.lang.Long> mappingFunction)
```
    Specified by:
    
    compute in interface java.util.Map<T,java.lang.Long>
  - computeIfAbsent
```
default java.lang.Long computeIfAbsent(T key,
                                       java.util.function.Function<? super T,? extends java.lang.Long> mappingFunction)
```
    Specified by:
    
    computeIfAbsent in interface java.util.Map<T,java.lang.Long>
  - computeIfPresent
```
default java.lang.Long computeIfPresent(T key,
                                        java.util.function.BiFunction<? super T,? super java.lang.Long,? extends java.lang.Long> mappingFunction)
```
    Specified by:
    
    computeIfPresent in interface java.util.Map<T,java.lang.Long>
  - merge
```
default java.lang.Long merge(T key,
                             java.lang.Long value,
                             java.util.function.BiFunction<? super java.lang.Long,? super java.lang.Long,? extends java.lang.Long> mappingFunction)
```
    Specified by:
    
    merge in interface java.util.Map<T,java.lang.Long>
  - forEach
```
void forEach(ObjectLongConsumer<T> action)
```
    Type Specific forEach method to reduce boxing/unboxing
    
    Parameters:
    
    action - processor of the values that are iterator over
  - forEach
```
default void forEach(java.util.function.BiConsumer<? super T,? super java.lang.Long> action)
```
    Specified by:
    
    forEach in interface java.util.Map<T,java.lang.Long>
  - keySet
```
ObjectSet<T> keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<T,java.lang.Long>
  - values
```
LongCollection values()
```
    Specified by:
    
    values in interface java.util.Map<T,java.lang.Long>
  - entrySet
```
ObjectSet<java.util.Map.Entry<T,java.lang.Long>> entrySet()
```
    Specified by:
    
    entrySet in interface java.util.Map<T,java.lang.Long>
  - object2LongEntrySet
```
ObjectSet<Object2LongMap.Entry<T>> object2LongEntrySet()
```
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Returns:
    
    a EntrySet of the collection
  - synchronize
```
default Object2LongMap<T> synchronize()
```
    Creates a Wrapped Map that is Synchronized
    
    Returns:
    
    a new Map that is synchronized
    
    See Also:
    
    Object2LongMaps.synchronize(speiger.src.collections.objects.maps.interfaces.Object2LongMap<T>)
  - synchronize
```
default Object2LongMap<T> synchronize(java.lang.Object mutex)
```
    Creates a Wrapped Map that is Synchronized
    
    Parameters:
    
    mutex - is the controller of the synchronization block
    
    Returns:
    
    a new Map Wrapper that is synchronized
    
    See Also:
    
    Object2LongMaps.synchronize(speiger.src.collections.objects.maps.interfaces.Object2LongMap<T>)
  - unmodifiable
```
default Object2LongMap<T> unmodifiable()
```
    Creates a Wrapped Map that is unmodifiable
    
    Returns:
    
    a new Map Wrapper that is unmodifiable
    
    See Also:
    
    Object2LongMaps.unmodifiable(speiger.src.collections.objects.maps.interfaces.Object2LongMap<T>)
  - put
```
default java.lang.Long put(T key,
                           java.lang.Long value)
```
    Specified by:
    
    put in interface java.util.Map<T,java.lang.Long>
  - putIfAbsent
```
default java.lang.Long putIfAbsent(T key,
                                   java.lang.Long value)
```
    Specified by:
    
    putIfAbsent in interface java.util.Map<T,java.lang.Long>

Interface Object2LongMap<T>

Nested Class Summary

Method Summary

Methods inherited from interface java.util.Map

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

Method Detail

builder

getDefaultReturnValue

setDefaultReturnValue

copy

put

putAll

putAll

putAll

putAll

putIfAbsent

putAllIfAbsent

addTo

addToAll

subFrom

putAll

containsValue

containsValue

rem

remove

remove

remove

remOrDefault

replace

replace

replaceLongs

replaceLongs

computeLong

computeLongIfAbsent

supplyLongIfAbsent

computeLongIfPresent

mergeLong

mergeAllLong

replace

replace

getLong

getOrDefault

get

getOrDefault

replaceAll

compute

computeIfAbsent

computeIfPresent

merge

forEach

forEach

keySet

values

entrySet

object2LongEntrySet

synchronize

synchronize

unmodifiable

put

putIfAbsent